# IDH_CONTENTS
Contents

Welcome to

heilerSoftware Online

HighEdit Pro

OCX

Programmable Word Processing

for Windows

	Function Index  Properties  Events


Function Groups
Function Index

The functions below are arranged alphabetically, and cover the full range of HighEdit functionality. All functions are defined in the OCX file, and can thus be called from any programming system which supports OCX.

All examples below use Visual Basic Syntax.

Bitmaps

Bookmarks

Clipboard

Cursor

Data Fields

Data Transfer

Determine Options

Dialog Boxes

Dimensions

Font

Formatting

Header/Footer

HTML Export

Hyperlinks

Open

Other

Preview

Print

Query

Save

Screen Display

Search/Replace

Select

Set Options

Table

Tabs

Undo


Data Fields

AddAllPFFlags

AddFunctionPF

AddPFFlags

ChangeFunctionPF

ClearAllPFFlags

ClearPFFlags

CloseActivePF

DeletePF

ExtInsertFunctionPF

GetFunctionPFData

GetFunctionPFDataLen

GetFunctionPFName

GetFunctionPFNameLen

GetFunctionPFTableCount

GetFunctionPFTyp

GetPFData

GetPFDataLen

GetPFFlags

GetPFWidth

InsertFunctionPF

IsPFActive

NextPF

SetAllPFFlags

SetAllPFWidth

SetPFFlags

SetPFWidth


Cursor

CursorEnd

CursorHome

GetCursor

GetCursorExt

SetCursor

SetCursorExt


Bitmaps

GetPictureDim

GetPictureFlags

GetPictureOffset

InsertBitmap

LoadPicture

SetPictureDim

SetPictureFlags

SetPictureOffset

PictureDlg


Print

GetPrinterCursorHeight

GetPrinterDC

GetPrinterDim

GetPrinterIC

GetPrinterLineHeight

GetPrinterLineWidth

PrintDlg

PrintSetupDlg

PrintDoc

PrintDocAbortDlg

PrintDocParamAbortDlg

PrintDocParamHwndAbortDlg

PrintInsertDoc

GetInstancePrinter

SetInstancePrinter


Open

AppendDoc

AppendDlg

LoadDoc

LoadDlg


Tabs

GetTabCount

GetTabList

GetTabWidth

ParagraphDlg

SetTabList

SetTabWidth


Save

SaveDoc

SaveDlg


Dimensions

GetPhysicalMargins

Note: Logical units of measure are controlled by properties.


Select

GetSelectedText

GetSelection

GetSelectionExt

GetSelectionStart

IsSelection

ReplaceSel

SelectAll

SelectWord

SetSelection

SetSelectionEditable

SetSelectionExt


Data Transfer

CopyData

CopyDataGlobalMem

PasteData

PasteDataGlobalMem

CopyRTF

CopyRTFGlobalMem

PasteRTF

PasteRTFGlobalMem


Clipboard

CanCopy

CanPaste

Clear

Copy

Cut

Paste


Header/Footer

ShowHeadFoot

IsHeadFootVisible


Query

IsCellActive

IsClearDelete

IsFormfeed

IsIgnoreEditable

IsLineEditable

IsModified

IsPercentThumb

IsTableActive

IsScreenFont

IsScreenFontsEnabled

IsSelection

IsTableActive

IsTableSelected


Screen Display

BackColorDlg

ColorDlg

DisplayStatusText

ExtSetRedraw

Redraw

SetGrayBk


Formatting

FormatDoc

Paginate

FormatDocDlg


HTML-Export
HTML Export

ExportHTML

ExportHTMLDialog


Set Options

SetClearDelete

SetContext

SetEOFChar

SetFileName

SetIgnoreEditable

SetLineEditable

SetModified

SetOffset

SetPageCounter

SetPathName

SetPercentThumb

SetRedraw

SetStyle


Font

GetHEFont

GetFontHandle

GetFontIndex

SetHEFont

EnableScreenFonts

GetScreenFont

IsScreenFont

IsScreenFontsEnabled

FontDlg

ColorDlg


Determine Options

GetChars

GetColor

GetContext

GetEOFChar

GetFileFormat

GetFileName

GetLine

GetLineCount

GetLineLength

GetPage

GetPathName

GetRGB

GetStyle

GetTyp

GetVersion


Search/Replace

QuickReplace

ReplaceDlg

Search

SearchContinue

SearchDlg


Undo

CanUndo

ClearUndoList

GetUndoDepth

HEUndo

QueryUndoType

SetUndoDepth


Table

AppendTableCell

AppendTableColumn

AppendTableRow

BorderDlg

CellDimDlg

DeleteTableCell

DeleteTableColumn

DeleteTableRow

GetBorder

GetCell3D

GetCellShading

GetColumnWidth

GetCurRowHeight

GetGap

GetRange

GetRowHeight

GetRowHeightType

GetTableCount

GetTableRange

InsertTable

InsertTableCell

InsertTableColumn

InsertTableRow

IsCellActive

IsTableActive

IsTableSelected

LinkCells

SelectTable

SelectTableCell

SelectTableRow

SetBorder

SetCell3D

SetCellShading

SetColumnWidth

SetGap

SetRowHeight

SplitCells

SplitCellsDlg

TableInsertDlg


Preview

IsPreview

Preview


Other

CharInsert

Clear

CloseChild

DocInfoDlg

EndSession

HideDropDown

GetActiveHighEdit

GetActiveIconBar

GetActiveMenuBar

GetActiveStatusBar

InitNewDoc

SendMessage

SendMessageEx

ToggleFormfeed

WinIniChange

WriteProfile


Bookmarks

BookMarkColorDlg

CanInsertBookMark

CanRemoveBookMark

GetBookMarkID

InsertBookMark

RemoveBookMarkCanRemoveBookMarkGetBookMarkID


Hyperlinks

CanInsertHyperLink

CanRemoveHyperLink

GetHyperLinkData

GetHyperLinkID

HyperLinkColorDlg

InsertHyperLink

RemoveHyperLink

SetHyperLinkDataGetHyperLinkDataGetHyperLinkID


Dialog Boxes

A number of dialog boxes are available in HighEdit which can be linked into an application by calling a function.

AppendDlg

BorderDlg

BackColorDlg

BookMarkColorDlg

CellDimDlg

ColorDlg

DeleteDlg

DocInfoDlg

FontDlg

FormatDocDlg

HyperLinkColorDlg

LoadDlg

LoadInfoDlg

ParagraphDlg

PictureDlg

PrintDlg

PrintSetupDlg

ReplaceDlg

SaveDlg

SaveAsDlg

SearchDlg

TableInsertDlg


AddAllPFFlags

Description:	Searches in all input fields of the types indicated in the entire text and adds new settings to the field settings already present.

Function:	BOOL AddAIIPFFlags

(

short 	nFlags,

short 	nLevel,

short * 	lpnTypList

)

Parameters:	nFlags

One or more of the following flags:

PF_VISIBLE	Show input field.

PF_EDITABLE	Input field is editable.

PF_LINEREMOVE	If the input field is not visible, the entire row will be hidden.

PF_ALIGNLEFT	Left-aligned output within the field

PF_ALIGNRIGHT	Right-aligned output within the field
PF_FIXEDSIZE is required for this.

PF_FIXEDSIZE	The input field has a fixed width and does not adjust itself to the content.

nLevel

For later development only; must be set to -1.

lpnTypList

A field consisting of integers with the field types that are to be found. The first element of the field contains the number of types which follow. The first element must be passed when a call is made.

Result:	BOOL

TRUE:	New settings made

FALSE:	Error while settings were being made

Example:	Add the flag PF_VISIBLE in fields of type CLIENT and PROSPECT.

ReDim TypList (3)
TypList (0) = 2
TypList (1) = TYP_KUNDE
TypList (2) = TYP_INTERESSENT
Success% = HighEdit1.AddAllPFFlags (PF_VISIBLE, -1,TypList(0) )

See also:	ClearAllPFFlags
ClearPFFlags


AddFunctionPF

Description:	Sets the function name of an input field in the field table to the type indicated. If a field with the type indicated is already present in the table, its name will be overwritten by the new one.

Function:	BOOL AddFunctionPF

(

short 	nTyp,

BSTR 	pszName

)

Parameters:	nTyp

Type of input field

pszName

New field name

Result:	BOOL

TRUE	Field name set

FALSE	Error while setting name

Example:	result = HighEdit1.AddFunctionPF (TYP_USER + 40, "{Client}")

See also:	DeletePF
InsertFunctionPF
ExtInsertFunctionPF


AddPFFlags

Description:	Adds new field settings to the input field at the cursor position.

Function:	BOOL AddPFFlags

(

short 	nFlags

)

Parameters:	nFlags

One or more of the following values:

PF_VISIBLE	Show input field.

PF_EDITABLE	Input field is editable.

PF_LINEREMOVE	If the input field is not visible, the entire row will be hidden.

PF_ALIGNLEFT	Left-aligned output within the field

PF_ALIGNRIGHT	Right-aligned output within the field. PF_FIXEDSIZE is required for this.

PF_FIXEDSIZE	The input field has a fixed width and does not adjust itself to the content.

PF_MULTILINE	The input field can be several rows long.

Result:	BOOL

TRUE:	New settings made

FALSE:	No input field present at the cursor position

Example:	result = HighEdit1.AddPFFlags (PF_MULTILINE)

See also:	ClearPFFlags
AddAllPFFlags
ClearAllPFFlags


AppendDlg

Description:	Add dialog box to file. A selected file is taken directly into HighEdit without existing text first being deleted.

Function:	BOOL AppendDlg

(

)

Result:	BOOL

TRUE:	File was inserted.

FALSE:	Cancel or error while file was being inserted.

Example:	result = HighEdit1.AppendDlg ()

See also:	LoadDlg
AppendDoc


AppendDoc

Description:	Insert a document at the cursor position. Existing document will not be overwritten.

Function:	BOOL AppendDoc

(

BSTR 	pszFileName,

short 	nFormat

)

Parameters:	pszFileName

Complete file name with path and extension.

nFormat

The format of the file

FILEFORMAT_HIGHEDIT	Specific format including all information

FILEFORMAT_ANSI	All ASCII-ANSI text

FILEFORMAT_OEM	All ASCII-OEM text

FILEFORMAT_RTF	Text in Rich-Text format

Result:	BOOL

TRUE:	File successfully inserted

FALSE:	Error while inserting file

Example:	result = HighEdit1.AppendDoc ("TEST.HED", FILEFORMAT_HIGHEDIT)

See also:	LoadDoc
ReplaceSel
Paste


AppendTableCell

Description:	Pastes the currently active row into a new table cell. In order for this to be performed successfully, a table context should be active, i.e. the IsTableActive method should have returned TRUE.

Function:	BOOL AppendTableCell

(

)

Parameters:	None

Result:	BOOL

TRUE:	Action performed successfully

FALSE:	Error

Example:	result = HighEdit1.AppendTableCell()

See also:	DeleteTableCell
InsertTableCell


AppendTableColumn

Description:	Inserts a new table column into the currently active table. In order for this to be performed successfully, a table context should be active, i.e. the IsTableActive method should have returned TRUE.

Function:	BOOL AppendTableColumn

(

)

Parameters:	None

Result:	BOOL

TRUE:	Action performed successfully

FALSE:	Error

Example:	result = HighEdit1.AppendTableColumn()

See also:	DeleteTableColumn
InsertTableColumn


AppendTableRow

Description:	Inserts a new table row into the currently active table. In order for this to be performed successfully, a table context should be active, i.e. the IsTableActive method should have returned TRUE.

Function:	BOOL AppendTableRow

(

)

Parameters:	None

Result:	BOOL

TRUE:	Action performed successfully

FALSE:	Error

Example:	result = HighEdit1.AppendTableRow()

See also:	DeleteTableRow
InsertTableRow


BackColorDlg

Description:	Dialog box for setting the background for the window and field.

Function:	BOOL BackColorDlg

(

)

Result:	BOOL

TRUE:	Color was set.

FALSE:	Dialog box was canceled.

Example:	result = HighEdit1.BackColorDlg ()

See also:	ColorDlg


BookMarkColorDlg

Description:	Dialog box for setting the bookmark color

Function:	BOOL BookMarkColorDlg

(

)

Result:	BOOL

TRUE:	Color was set.

FALSE:	Dialog box was canceled.

Example:	result = HighEdit1.BookMarkColorDlg ()

See also:	ColorDlg


BorderDlg

Description:	Activates the Border and Shading dialog box to determine border attributes including style, line thickness and color, the 3D-effect and the background shading of the current table context. After confirmation of the dialog box, the values are accepted.

To ensure that a correct table context has been given, one of the two methods IsCellActive or IsTableSelected should have returned TRUE.

Function:	BOOL BorderDlg

(

)

Parameters:	None

Result:	BOOL

TRUE:	The dialog was confirmed and the attributes accepted.

FALSE:	No table context given or dialog canceled.

Example:	result = HighEdit1.BorderDlg()

See also:	GetBorder
SetBorder


CanCopy

Description:	Determines whether a section of text is selected and may thus be copied.

Function:	BOOL CanCopy

(

)

Result:	BOOL

TRUE:	Section of text is selected.

FALSE:	No marking (selection) present

Example:	result = HighEdit1.CanCopy()

See also:	Copy
CanPaste
Paste


CanInsertBookMark

Description:	Tests whether a new text mark can be inserted at the current insertion point.

Function:	BOOL CanInsertBookMark

(

)

Parameters:	None

Result:	BOOL

TRUE:	Text mark can be inserted.

FALSE:	Text mark cannot be inserted.

Example:	result = HighEdit1.CanInsertBookMark()

See also:	InsertBookMark
CanRemoveBookMark
RemoveBookMark


CanInsertHyperLink

Description:	Tests whether a new hyperlink can be inserted at the current insertion point.

Function:	BOOL CanInsertHyperLink

(

)

Result:	BOOL

TRUE:	Hyperlink can be inserted.

FALSE:	Hyperlink cannot be inserted.

Example:	result = HighEdit1.CanInsertHyperLink()

See also:	InsertHyperLink
CanRemoveHyperLink
RemoveHyperLink


CanPaste

Description:	Determines whether data which can be inserted is present in the clipboard.

Function:	BOOL CanPaste

(

)

Result:	BOOL

TRUE	Data present

FALSE	No data present

Example:	result = HighEdit1.CanPaste ()

See also:	CanCopy
Copy
Paste


CanRemoveBookMark

Description:	Tests whether a text mark is present at the current insertion point, or if one or more texts marks are present within the currently selected section, and whether it/they could be deleted by a subsequent RemoveBookMark.

Function:	BOOL CanRemoveBookMark

(

)

Parameters:	None

Result:	BOOL

TRUE:	Text mark(s) which could be deleted is/are present.

FALSE:	No text mark(s) present

Example:	result = HighEdit1.CanRemoveBookMark()

See also:	CanInsertBookMark
RemoveBookMark
InsertBookMark


CanRemoveHyperLink

Description:	Tests whether a hyperlink is present at the current insertion point, or if one or more hyperlinks are present within the currently selected section, and whether it/they could be deleted by a subsequent RemoveHyperLink.

Function:	BOOL CanRemoveHyperLink

(

)

Parameters:	None

Result:	BOOL

TRUE:	Hyperlink(s) which could be deleted is/are present.

FALSE:	No hyperlinks(s) present.

Example:	result = HighEdit1.CanRemoveBookMark()

See also:	CanInsertHyperLink
RemoveHyperLink
InsertHyperLink


CanUndo

Description:	Determines whether an action which can be undone is available on the UNDO stack.

Function:	BOOL CanUndo

(

)

Result:	BOOL

TRUE:	An action can be undone.

FALSE:	No action present

Example:	result = HighEdit1.CanUndo()

See also:	Undo
ClearUndoList
GetUndoDepth
QueryUndoType
SetUndoDepth


CellDimDlg

Description:	Activates the Cell Height and Width dialog box to determine the row height, height type, column width and space between columns of the current table context. After confirmation of the dialog, the values are accepted.

To ensure that a correct table context has been given, one of the two methods IsCellActive or IsTableSelected should have returned TRUE.

Function:	BOOL CellDimDlg

(

)

Parameters:	None

Result:	BOOL

TRUE:	The dialog was confirmed and the attributes accepted.

FALSE:	No table context given or dialog canceled.

Example:	HighEdit1.CellDimDlg()

See also:	GetRowHeight
SetRowHeight


ChangeFunctionPF

Description:	Changes the content of an input field of the type indicated.

Function:	BOOL ChangeFunctionPF

(

short 	nTyp,

BSTR 	pszNewText

)

Parameters:	nTyp

Type of input field

pszNewText

New content

Result:	BOOL

TRUE:	Change successful

FALSE:	Error during change

Example:	result = HighEdit1.ChangeFunctionPF ( TYP_USER + 30, "Test")

See also:	GetPFData


CharInsert

Description:	Adds a character with the character code indicated at the cursor position.

Function:	CharInsert

(

short 	nChar

)

Parameters:	nChar

Character code

Example:	HighEdit1.CharInsert (65)

See also:	ReplaceSel
GetChars


Clear

Description:	Deletes the currently selected section. Data is not copied into the clipboard.

Function:	Clear

(

)

Example:	HighEdit1.Clear

See also:	Cut
Copy


ClearAllPFFlags

Description:	Searches in all input fields of the types indicated in the entire text and deletes the settings indicated from the field settings already present.

Function:	BOOL ClearAIIPFFlags

(

short 	nFlags,

short 	nLevel,

short * 	lpnTypList

)

Parameters:	nFlags

One or more of the following flags:

PF_VISIBLE	Show input field.

PF_EDITABLE	Input field is editable.

PF_LINEREMOVE	If the input field is not visible, the entire row will be hidden.

PF_ALIGNLEFT	Left-aligned output within the field

PF_ALIGNRIGHT	Right-aligned output within the field.
PF_FIXEDSIZE is required for this.

PF_FIXEDSIZE	The input field has a fixed width and does not adjust itself to the content.

nLevel

For later development only; must be set to -1.

lpnTypList

A field consisting of integers with the field types that are to be found. The first element of the field contains the number of types which follow. The first element must be passed when a call is made.

Result:	BOOL

TRUE:	New settings made

FALSE:	Error while settings were being made

Example:	Add the flag PF_VISIBLE in fields of type CLIENT and PROSPECT.

ReDim TypList (3)
TypList (0) = 2
TypList (1) = TYP_KUNDE
TypList (2) = TYP_INTERESSENT

Success% = HighEdit1.ClearAllPFFlags ( PF_VISIBLE, -1,TypList(0) )

See also:	AddAllPFFlags
ClearPFFlags
ClearAllPFFlags


ClearPFFlags

Description:	Deletes the field settings indicated from the input field at the cursor setting.

Function:	BOOL ClearPFFlags

(

short 	nFlags

)

Parameters:	nFlags

One or more of the following values:

PF_VISIBLE	Show input field.

PF_EDITABLE	Input field is editable.

PF_LINEREMOVE	If the input field is not visible, the entire row will be hidden.

PF_ALIGNLEFT	Left-aligned output within the field

PF_ALIGNRIGHT	Right-aligned output within the field. PF_FIXEDSIZE is required for this.

PF_FIXEDSIZE	The input field has a fixed width and does not adjust itself to the content.

PF_MULTILINE	The input field can be several rows long.

Result:	TRUE	New settings replaced

FALSE	No input field present at the cursor position

Example:	result = HighEdit1.ClearPFFlags(PF_MULTILINE)

See also:	AddAllPFFlags
AddPFFlags
ClearAllPFFlags


ClearUndoList

Description:	Deletes the UNDO stack. The memory allocated for UNDO actions is freed up in the process.

Function:	ClearUndoList

(

)

Result:	None

Example:	HighEdit1.ClearUndoList

See also:	Undo
CanUndo
GetUndoDepth
QueryUndoType
SetUndoDepth


CloseActivePF

Description:	Closes an open input field, thus ending input.

Function:	BOOL CloseActivePF

(

short 	nRedraw

)

Parameters:	nRedraw

TRUE	Redraw the screen

FALSE	No redraw

Result:	BOOL

TRUE	Input field successfully closed

FALSE	The input field remains open, since validation via Event ModifyPF was not successful.

Example:	result = HighEdit1.CloseActivePF ( TRUE)


CloseChild

Description:	Closes the HighEdit window. The Event QueryCloseChild may also be initiated.

Function:	BOOL CloseChild

(

)

Result:	BOOL

TRUE:	HighEdit was closed.

FALSE:	HighEdit is still open.

Example:	result = HighEdit1.CloseChild ()

See also:	EndSession


ColorDlg

Description:	Dialog box for selecting text color. It is not necessary for the index to agree with the one in HighEdit. To set the desired color, GetRGB should therefore be used with all indices to determine the current color palette in HighEdit.

Function:	short ColorDlg

(

)

Result:	Index (0 .. 15) to the color selected in the dialog box; -1 on cancel.

Example:	result = HighEdit1.ColorDlg ()

See also:	GetRGB
BackColorDlg


Copy

Description:	Copies the currently selected section into the clipboard.

Function:	Copy

(

)

Example:	HighEdit1.Copy()

See also:	Clear
CopyData


CopyData

Description:	Copies the selected text into a global storage region. All text attributes and formatting are stored in a second storage region. The entire text can be inserted later with PasteData. The buffer size required is calculated and set automatically, but must not exceed 64kB.
CopyDataGlobalMem() can be used to copy larger quantities of data.

Function:	BOOL CopyData

(

BSTR* 	pbstrFormat,

BSTR* 	pbstrText

)

Parameters:	pbstrFormat

The string into which text attributes are loaded

pbstrText

The string into which plain text is loaded

Result:	BOOL

TRUE:	Data was successfully copied.

FALSE:	Error during copy

Example:	result = HighEdit1.CopyData (pbstrFormat$, pbstrText$)

See also:	PasteData
CopyDataGlobalMem


CopyDataGlobalMem

Description:	Copies the selected text into a global storage region. All text attributes and formatting are stored in a second storage region. The entire text can be pasted in again with PasteDataGlobalMem. VB strings are not used for storage; Windows GLOBALHANDLE is used instead. After the handles are used, they must be freed up again. Both handles will be freed up if the two Boolean parameters of the function PasteDataGlobalMem are TRUE.

Function:	BOOL CopyDataGlobalMem

(

long *  	lplFormat,

long * 	lplText

)

Parameters:	lplFormat

The global handle into which text attributes are loaded

lplText

The global handle into which plain text is loaded

Result:	BOOL

TRUE:	Data was successfully copied.

FALSE:	Error during copy

Example:	result = HighEdit1.CopyDataGlobalMem (lFormat&, nText&)
result = HighEdit1.PasteDataGlobalMem (lFormat&, lText&,TRUE, TRUE)

See also:	PasteDataGlobalMem
CopyData


CopyRTF

Description:	Copies the selected segment of text into a string in RTF format. The necessary memory is automatically reserved.

Function:	BOOL CopyRTF

(

BSTR *	sRTF

)

Parameters:	sRTF

The string which contains the RTF text after processing. The necessary storage space for the string is automatically reserved.

Result:	BOOL

TRUE:	Data was successfully copied.

FALSE:	Error during copy

Note:	In VB 4.0, the maximum length of strings is 64 kB. To process larger quantities of data, you will need to access global Windows memory. This processing then takes place with CopyRTFGlobalMem().

Example:	success% = HighEdit1.CopyRTF(sRTF)

See also:	PasteRTF
CopyRTFGlobalMem
PasteRTFGlobalMem


CopyRTFGlobalMem

Description:	Copies the selected section of text into global Windows memory in RTF format. The memory is automatically reserved in the process.

Function:	BOOL CopyRTFGlobalMem

(

long * 	lpnRTF

)

Parameters:	lpnRTF

The global handle which contains the RTF text after processing

Result:	BOOL

TRUE:	Text was successfully copied.

FALSE:	Error during copying of text

Example:	success% = HighEdit1.CopyRTFGlobalMem(iRTF&)
iFree% = 1
sucess% = HighEdit1.PasteRTFGlobalMem(iRTF&, iFree%)

See also:	CopyRTF
PasteRTF
PasteRTFGlobalMem


CursorEnd

Description:	Sets the cursor at the end of the text.

Function:	CursorEnd

(

)

Example:	HighEdit1.CursorEnd()

See also:	CursorHome
SetCursor


CursorHome

Description:	Sets the cursor at the beginning of the text.

Function:	CursorHome

(

)

Example:	HighEdit1.CursorHome()

See also:	CursorEnd
SetCursor


Cut

Description: 	Cuts the currently selected section and copies it into the clipboard.

Function:	Cut

(

)

Example:	HighEdit1.Cut

See also:	Clear


DeleteDlg

Description:	Dialog box for deleting files

Function:	BOOL DeleteDlg

(

)

Result:	BOOL

TRUE:	File was deleted.

FALSE:	Cancel or error during deletion of file

Example:	result = HighEdit1.DeleteDlg ()


DeletePF

Description: 	Deletes the input field at the cursor position.

Function:	BOOL DeletePF

(

short 	nRedraw

)

Parameters:	nRedraw

TRUE	Screen update after deletion

FALSE	No screen update

Result:	BOOL

TRUE:	Deletion successful

FALSE:	Error during deletion

Example:	result = HighEdit1.DeletePF (TRUE)

See also:	InsertFunctionPF
ExtInsertFunctionPF


DeleteTableCell

Description:	Deletes the table cell at the current cursor position. In order for this to be performed successfully, a table context should be active, i.e. the IsTableActive method should have returned TRUE.

Function:	BOOL DeleteTableCell

(

)

Result:	BOOL

TRUE:	Action performed successfully

FALSE:	Error

Example:	HighEdit1.DeleteTableCell()

See also:	InsertTableCell
AppendTableCell


DeleteTableColumn

Description:	Deletes the table column at the current cursor position. In order for this to be performed successfully, a table context should be active, i.e. the IsTableActive method should have returned TRUE.

Function:	BOOL DeleteTableColumn

(

)

Result:	BOOL

TRUE:	Action performed successfully

FALSE:	Error

Example:	HighEdit1.DeleteTableColumn()

See also:	InsertTableColumn
AppendTableColumn


DeleteTableRow

Description:	Deletes the table row at the current cursor position. In order for this to be performed successfully, a table context should be active, i.e. the IsTableActive method should have returned TRUE.

Function:	BOOL DeleteTableRow

(

)

Result:	BOOL

TRUE:	Action performed successfully

FALSE:	Error

Example:	HighEdit1.DeleteTableRow()

See also:	InsertTableRow
AppendTableRow


DisplayStatusText

Description:	Displays text in the HighEdit StatusBar.

Function:	DisplayStatusText

(

BSTR 	sText

)

Parameters:	sText

Text to be displayed

Example:	DisplayStatusText  ("Test")


DocInfoDlg

Description:	Dialog box for changing the document additional information

Function:	BOOL DocInfoDlg

(

)

Result:	BOOL

TRUE:	Additional information reset

FALSE:	Cancel

Example:	result = HighEdit1.DocInfoDlg ()


EnableScreenFonts

Description:	Turns the screen fonts on or off.

Function:	EnableScreenFonts

(

BOOL	bScreenFonts

)

Parameters:	bScreenFonts

TRUE 	Screen fonts are available.

FALSE	Only printer fonts are available.

Result:	None

Example:	HighEdit1.EnableScreenFonts (TRUE)

See also:	IsScreenFontsEnabled


EndSession

Description:	Tells HighEdit that the system will be terminated at once. The external storage file is then closed. The message WM_ENDSESSION is automatically redirected to HighEdit, so that this function should not normally be required.

Function:	EndSession

(

BOOL 	bParam

)

Parameters:	bParam

Corresponds to wParam of the Windows message WM_ENDSESSION:

Non-zero if Windows is being terminated; otherwise 0.

Example:	HighEdit1.EndSession (0)

See also:	CloseChild


ExportHTML

Description:	Exports the entire text into HTML format (Hyper Text Markup Language).

Function:	ExportHTML

(

BSTR*	pbstrFileName,

BSTR*	pbstrTitle,

long	lFlags

)

Parameters:	pbstrFileName

Path and filename of target file. Must be filled in. For buffer export (HTML_BUFFER) the images referenced in the HTML document are stored under this path.

pbstrTitle

A string which is exported into the HTML document as a title if the flag HTML_TITLE is set.

lFlags

Options for controlling the export:

One of these two options:

HTML_FILE	Export to a file.

HTML_BUFFER	Export to a storage string.

These options may also be added if you wish:

HTML_FORMULAR 	HighEdit Pro data fields are exported into the HTML document as input fields.

HTML_BACKGROUND	The background color set in HighEdit Pro is taken over into the HTML document.

HTML_HYPERLINKS 	The hyperlinks and bookmarks that were defined in HighEdit Pro are taken over into the HTML document as anchors.

HTML_IMAGE_xxx 	The following flags control the image export:

HTML_IMAGE_NONE: No image export.

HTML_IMAGE_JPG: Image export as JPG.

HTML_IMAGE_GIF: Image export as GIF.

HTML_TITLE 	The string passed in pbstrTitle is exported as the title of the HTML document and displayed by the browser as a window caption if this HTML document is opened.

These options control how HighEdit Pro behaves during export. They can be added optionally:

HTML_CURSOR	The Wait cursor is displayed during export.

HTML_NOTIFY 	A status message (percentage progress) is displayed during export.

Result:	long

0:	Error

Non-zero:	Action performed successfully, upon successful HTML export, and with the option HTML_BUFFER, returns the handle of the memory allocated for the HTML string. The application is responsible for freeing up the memory.

Example:	sFileName$ = c:\temp\test.htm

sTitle$ = Test document

HighEdit1.ExportHTML ( sFileName, sTitle, HTML_FILE or HTML_BACKGROUND or HTML_IMAGE_NONE )

See also:	ExportHTMLDialog
HTML export of graphics
HTML export of hyperlinks and bookmarks
HTML export of data fields


ExportHTMLDialog

Description:	Activates the HTML export dialog box to specify the file name and export options. The values passed are used as default values in the dialog box. After the dialog box has been confirmed, the entire text will be exported into HTML format (Hyper Text Markup Language). The possibly changed file name and title are returned.

Function:	ExportHTMLDialog

(

BSTR*	pbstrFileName,

BSTR*	pbstrTitle,

long	lFlags

)

Parameters:	pbstrFileName

Path and filename of target file. Must be filled in. For buffer export (HTML_BUFFER) the images referenced in the HTML document are stored under this path.

pbstrTitle

A string which is exported into the HTML document as a title if the flag HTML_TITLE is set.

lFlags

Options for controlling the export, see methode ExportHTML for a detailed description.

Result:	long

0:	Error

Non-zero:	Action performed successfully, upon successful HTML export, and with the option HTML_BUFFER, returns the handle of the memory allocated for the HTML string. The application is responsible for freeing up the memory.

Example:	sFileName$ = c:\temp\test.htm

sTitle$ = Test document

HighEdit1.ExportHTMLDialog ( sFileName, sTitle, HTML_FILE or HTML_BACKGROUND or HTML_IMAGE_NONE )

See also:	ExportHTML
HTML export of graphics
HTML export of hyperlinks and bookmarks
HTML export of data fields


ExtInsertFunctionPF

Description:	Inserts an input field of the type indicated at the cursor position. The field settings can be given at the time of insertion.

Function:	BOOL ExtInsertFunctionPF

(

short 	nTyp,

short 	nFlags,

BSTR 	pszText

)

Parameters:	nTyp

Type of input field

nFlags

One or more of the following flags:

PF_VISIBLE	Show input field.

PF_EDITABLE	Input field is editable.

PF_LINEREMOVE	If the input field is not visible, the entire row will be hidden.

PF_ALIGNLEFT	Left-aligned output within the field

PF_ALIGNRIGHT	Right-aligned output within the field. PF_FIXEDSIZE is required for this.

PF_FIXEDSIZE	The input field has a fixed width and does not adjust itself to the content.

pszText

Content of the field

Result:	BOOL

TRUE:	Insertion successful

FALSE:	Error during insertion

Example:	result = HighEdit1.ExtInsertFunctionPF ( TYP_USER +30, PF_VISIBLE + PF_ALIGNLEFT, "Data")

See also:	InsertFunctionPF
DeletePF


ExtSetRedraw

Description:	Turns screen display on and off. This function is required when display is turned off and other programs continue to run during this time. This might require redrawing the screen, which has, however, been turned off. If the screen content was temporarily stored, it can be retrieved from storage and displayed.

Function:	ExtSetRedraw

(

BOOL 	bRedraw,

BOOL 	bUpdate,

BOOL 	bSaveWindow

)

Parameters:	bRedraw

TRUE	Screen display on

FALSE	Screen display off

bUpdate

TRUE	The screen is redrawn when iRedraw = TRUE.

FALSE	No redraw when iRedraw = TRUE

bSaveWindow

TRUE	When iRedraw = FALSE the screen content will be temporarily stored.

FALSE	No storage of screen content when iRedraw = FALSE

Example:	HighEdit1.ExtSetRedraw (FALSE,FALSE, TRUE)

See also:	SetRedraw
Redraw


FontDlg

Description:	Dialog box for selecting and replacing a font.

Function:	BOOL FontDlg

(

)

Result:	BOOL

TRUE:	Font was selected or replaced

FALSE:	Cancel or error while selecting or replacing font

Example:	result = HighEdit1.FontDlg ()

See also:	GetHEFont
SetHEFont


FormatDoc

Description:	Formats the entire text to a particular text width.

Function:	FormatDoc

(

)

Example:	HighEdit1.FormatDoc()

See also:	Paginate


FormatDocDlg

Description:	Dialog box for determining the page format. The paper width and height is determined by the appropriate printer driver. If these values are changed, the margins will be converted by the corresponding factor. The dimensions of the paper are then set back to the actual physical size. If another paper format is used, it must be changed in the printer settings.

Function:	BOOL FormatDocDlg

(

)

Result:	BOOL

TRUE:	Format was set.

FALSE:	Cancel

Example:	result = HighEdit1.FormatDocDlg ()

See also:	FormatDoc


GetActiveIconBar

Description:	Returns the Window handle of the Icon Bar. This can be used for a wide range of functions with SendMessageEx.

Function:	long GetActiveIconBar

(

)

Parameters:	None

Result:	long lIconHandle

Example:	lIconHandle& = HighEdit1.GetActiveIconBar()

See also:	GetActiveHighEdit
GetActiveMenuBar
GetActiveStatusBar
SendMessageEx


GetActiveHighEdit

Description:	Returns the Window handle of the HighEdit Window. This can be used for a wide range of functions with SendMessageEx.

Function:	long GetActiveHighEdit

(

)

Parameters:	None

Result:	long lHighEditHandle

Example:	lHighEditHandle& = HighEdit1.GetActiveHighEdit()

See also:	GetActiveIconBar
GetActiveMenuBar
GetActiveStatusBar
SendMessageEx


GetActiveMenuBar

Description:	Returns the Window handle of the menu bar. This can be used for a wide range of functions with SendMessageEx.

Function:	long GetActiveMenuBar

(

)

Parameters:	None

Result:	long lMenuHandle

Example:	lMenuHandle& = HighEdit1.GetActiveMenuBar()

See also:	GetActiveHighEdit
GetActiveIconBar
GetActiveStatusBar
SendMessageEx


GetActiveStatusBar

Description:	Returns the Window handle of the StatusBar. This can be used for a wide range of functions with SendMessageEx.

Function:	long GetActiveStatusBar

(

)

Parameters:	None

Result:	long lStatusHandle

Example:	lStatusHandle& = HighEdit1.GetActiveStatusBar()

See also:	GetActiveHighEdit
GetActiveIconBar
GetActiveMenuBar
SendMessageEx


GetBookMarkID

Description:	Returns the ID of the text mark at the current insertion point.

Function:	short GetBookMarkID

(

)

Parameters:	None

Result:	short

Non-zero:	ID of the text mark

0:	No text mark present

Example:	result = HighEdit1.GetBookMarkID()

See also:	MoveTo


GetBorder

Description:	Determines the border attributes style, font width and color of the current table context. If the current insertion point is within a table cell, then the table context corresponds to this cell, i.e., the border attributes of this cell are determined. On the other hand, if multiple table sections are selected, the corresponding attributes are determined and adjusted to each other. If the attributes are identical, they are returned as the result. Otherwise -1 (INDEFINITE) is returned, which signifies that differing border attributes are present within the current table context.

The field nBorderPos in the structure passed as a parameter can be used to take a bitwise OR of constants BORDER_POS_LEFT, ..._TOP, ..._RIGHT, ..._BOTTOM, ..._HORIZONTAL and ..._VERTICAL to control access to variously positioned borders. The constant BORDER_POS_ALL is available for access to ALL borders of the table context.

To ensure that a correct table context is given, at least one of the two methods IsCellActive or IsTableSelected should have returned TRUE.

Function:	BOOL GetBorder

(

short 	nBorderPos,

short* 	pnBorderStyle,

short* 	pnPenWidth,

long* 	plColor

)

Parameters:	nBorderPos:

Takes a bitwise OR of constants BORDER_POS_LEFT, ..._TOP, ..._RIGHT, ..._BOTTOM, ..._HORIZONTAL and ..._VERTICAL to control access to variously positioned borders. The constant BORDER_POS_ALL is available for access to ALL borders.

pnBorderStyle:

Specifies the border style; can take on values BORDER_STYLE_NONE, ..._HAIR, ..._SINGLE, ..._DOUBLE, ..._DOT, ..._DASH, ..._SHADOW and INDEFINITE (= -1).

pnPenWidth,

Specifies line thickness in Twips. Note as a point of reference that 15 Twips corresponds to the style BORDER_STYLE_HAIR (hairline).

plColor:

Specifies the color as an RGB value.

Result:	BOOL

TRUE:	Border attributes successfully set (table context was given).

FALSE:	No table context present

Example:	HighEdit1.GetBorder(BORDER_POS_LEFT, nBorderStyle%, nPenWidth%, lColor&);

See also:	SetBorder
BorderDlg


GetCell3D

Description:	Determines the 3D-effect of the current table context. If the current insertion point is within a table cell, then the table context corresponds to this cell, i.e., the 3D-effect of the cell is determined. If multiple sections of a table are selected, on the other hand, the 3D-effects of all the selected cells are determined and compared against each other. If the values are identical, this is returned as the result. Otherwise -1 (INDEFINITE) is returned, which means that differing 3D-effects are present within the current table context.

To ensure that a correct table context is given, one of the two messages IsCellActive or IsTableSelected should have returned TRUE.

Function:	BOOL GetCell3D

(

short* 	pnCell3D

)

Parameters:	pnCell3D

INDEFINITE:	See above.

_3D_NONE:	No 3D-effect

_3D_POPIN:	Sunken display

_3D_POPOUT:	Raised display

Result:	BOOL

TRUE:	3D-effect was successfully determined (table context was given).

FALSE:	No table context present

Example:	result = HighEdit1.GetCell3D(nCell3D$)

See also:	SetCell3D
GetBorder
GetCellShading
BorderDlg


GetCellShading

Description:	Determines the background shading of the current table context. If the current insertion point is within a table cell, then the table context corresponds to this cell, i.e., the shading of this cell is determined. If multiple table sections are selected, on the other hand, then the shadings of all the selected cells are determined and compared against each other. If the shadings are identical, this is returned as the result. Otherwise a shading with nShading = -1 (INDEFINITE) is returned, which means that differing shadings are present in the current table context.

To ensure that a correct table context is given, one of the two messages IsCellActive or IsTableSelected should have returned TRUE.

Function:	BOOL SetCellShading

(

short* 	pnShading,

long* 	plForeColor,

long* 	plBackColor

)

Parameters:	pnShading:

Shading

plForeColor:

Foreground color

plBackColor:

Background color

Result:	BOOL

TRUE:	Background shading was successfully determined (table context was given).

FALSE:	No table context present

Example:	result = HighEdit1.SetCellShading(nShading$, lForeColor&, lBackColor&)

See also:	GetCell3D
SetCellShading
GetBorder
BorderDlg


GetCharOffset

Description:	Returns a non-ambiguous document offset of the current cursor position after considering the content of table cells.

Function:	long GetCharOffset

(

)

Parameters:	None

Result:	Non-ambiguous document offset of the current cursor position.

Example:	Save and restore the current cursor position.

'Save the cursor position

nPos& = HighEdit1.GetCharOffset

'Restore the cursor position

 	HighEdit1.MoveTo MT_CHAROFFSET, nPos&

See also:	MoveTo
GetCursorExt
SetCursorExt


GetChars

Description:	Returns the characters left and right of the cursor position.

Function:	GetChars

(

short *	lpnLeftChar,

short *	lpnRightChar

)

Parameters:	lpnLeftChar

character to the left

lpnRightChar

character to the right

Example:	HighEdit1.GetChars(iLeft%, iRight%)

See also:	GetLine
GetSelectedText


GetColor

Description:	Returns the currently set font color

Function:	long GetColor

(

)

Result:	Color value of type COLORREF

Example:	result = HighEdit1.GetColor

See also:	GetRGB


GetColumnWidth

Description:	Determines the column width of the current table context in 1/1000 of the current HighEdit unit (cm or inch). If the current insertion point is within a table cell, then the table context corresponds to this cell, i.e., the cell width is returned. If multiple table sections are selected, on the other hand, then the widths of all the selected cells are determined and compared against each other. If all widths are identical, that value is returned as the result. Otherwise -1 (INDEFINITE) is returned, which means that differing column widths are present in the current table context.

To ensure that a correct table context has been given, one of the two methods IsCellActive or IsTableSelected should have returned TRUE.

Function:	BOOL GetColumnWidth

(

short* 	pnColumnWidth

)

Parameters:	pnColumnWidth:

Column width

Result:	BOOL

TRUE:	Column width was successfully determined (table context was given).

FALSE:	No table context present

Example:	HighEdit1.GetColumnWidth(nColumnWidth&)

See also:	SetColumnWidth
CellDimDlg


GetContext

Description:	Determines which HighEdit window should contain messages when headers and footers are visible. By default, the window which has the focus contains the messages. Messages to HighEdit may then in some cases be redirected to the header or footer window.

Function:	short GetContext

(

)

Result:	One of the following values:

CONTEXT_MAIN	Main HighEdit contains the
messages

CONTEXT_HEAD	Header HighEdit contains the
messages

CONTEXT_FOOT	Footer HighEdit contains the
messages

Example:	result = HighEdit1.GetContext

See also:	SetContext


GetCurRowHeight

Description:	Determines the current row height of the current table context in 1/1000 of the current HighEdit unit (cm or inch). If the current insertion point is within a table cell, then the table context corresponds to this cell, i.e., the current height of this row is returned. If multiple table sections are selected, on the other hand, then the corresponding heights are determined and compared against each other. If all heights are identical, that value is returned as the result. Otherwise -1 (INDEFINITE) is returned, which means that differing row heights are present in the current table context.

This method is useful mostly in connection with the height type HEIGHT_TYPE_AUTO since the method GetRowHeight returns -1 (INDEFINITE) as the result.

To ensure that a correct table context is given, at least one of the two methods IsTableActive or IsTableSelected should have returned TRUE.

Function:	BOOL GetCurRowHeight

(

short* pnCurRowHeight

)

Parameters:	pnCurRowHeight

Current row height

Result:	BOOL

TRUE:	Current row height was successfully determined (table context was given).

FALSE:	No table context present

Example:	HighEdit1.GetCurRowHeight(nCurRowHeight&)

See also:	SetRowHeight
CellDimDlg
GetRowHeightType


GetCursor

Description:	Returns the current cursor position.

Function:	GetCursor

(

short * 	lpnCursorX,

long *  	lplCursorY

)

Parameters:	lpnCursorX

X-position

lplCursorY

Y-position

Example:	HighEdit1.GetCursor( x%, y&)

See also:	SetCursor
CursorHome
CursorEnd


GetCursorExt

Description:	Returns the current cursor position. In contrast to GetCursor, a currently active table cell is also considered in this procedure.

If the cursor is within the table cell, pnCellxxx is the position within the cell, otherwise -1.

Function:	BOOL GetCursorExt

(

long* 	pnYAbs,

short* 	pnXAbs,

long* 	pnCellYAbs,

short* 	pnCellXAbs,

)

Parameters:	pnYAbs

Y-position

pnXAbs

X-position

pnCellYAbs

Y-position within a table

pnCellXAbs

X-position within a table

Result:	BOOL

TRUE:	Position was successfully determined

FALSE:	Error

Example:	HighEdit1.GetCursor(nYAbs&, nXAbs%, nCellYAbs&, nCellXAbs&)

See also:	SetCursorExt
GetSelectionExt
SetSelectionExt


GetEOFChar

Description:	Returns the text end character.

Function:	short GetEOFChar

(

)

Result:	Character code in range >= 32 AND <= 255 AND NOT 127

Example:	result = HighEdit1.GetEOFChar

See also:	SetEOFChar


GetFileFormat

Description:	Returns the format of the current file.

Function:	short GetFileFormat

(

)

Parameters:	None

Result:	Current file format

FILEFORMAT_HIGHEDIT	Specific format including all information

FILEFORMAT_ANSI	All ASCII-ANSI text

FILEFORMAT_OEM	All ASCII-OEM text

FILEFORMAT_RTF	Text in Rich-Text format

Example:	result = HighEdit1.GetFileFormat()

See also:	GetFilePath
GetFileName


GetFileName

Description:	Returns the current file name, without path.

Function:	short GetFileName

(

BSTR * 	pbstrFileName

)

Parameters:	pbstrFileName

Buffer into which the file name is to be copied. The required size is determined automatically.

Result:	The length of the file name, including a null character at the end of the string.
0 on error.

Example:	result = HighEdit1.GetFileName (sName$)

See also:	SetFileName
GetPathName
SetPathName


GetFontHandle

Description:	Returns the handle to the desired font.

Function:	short GetFontHandle

(

short 	nIndex,

short 	nDevice

)

Parameters:	nIndex

Index in the font table; -1 for the current font

nDevice

Printer or screen font:

FONT_DISPLAY	Screen font

FONT_PRINTER	printer font

Result:	Handle  for the font
0 if no font with the index indicated exists.

Example:	result = HighEdit1.GetFontHandle ( -1,FONT_PRINTER)

See also:	GetFont
SetFont
GetStyle
GetFontIndex


GetFontIndex

Description:	Returns the index of the current font in the font table.

Function:	short GetFontIndex

(

)

Result:	Index of the current font

Example:	result = HighEdit1.GetFontIndex ()

See also:	GetFont
SetFont
GetStyle
GetFontHandle


GetFunctionPFData

Description:	Returns the content of the input field with the type indicated. The cursor must not be located in the input field.

Function:	short GetFunctionPFData

(

short 	nTyp,

BSTR * 	pbstrBuffer

)

Parameters:	nTyp

Type of input field

pbstrBuffer

The buffer which contains data. The required buffer size must be determined first with GetFunctionPFDataLen. The string must then be initialized to this size, plus 1 byte for the null character at the end.

Result:	The number of characters copied, excluding the null character.

Example:	Determine data from the field TYPE_CLIENT:

iLen% = HighEdit1.GetFunctionPFDataLen ( TYPE_CLIENT)
sBuffer$ = String$ (iLen% + 1, 0)
iChars% = HighEdit1.GetFunctionPFData (TYPE_CLIENT, sBuffer$)

See also:	GetPFData
GetFunctionPFName
GetFunctionPFDataLen
GetFunctionPFNameLen
GetFunctionPFTableCount
GetFunctionPFTyp


GetFunctionPFDataLen

Description:	Returns the length of the content of an input field with the type indicated. The cursor must not be located in the input field.

Function:	short GetFunctionPFDataLen

(

short 	nTyp

)

Parameters:	nTyp

Type of input field

Result:	Length of the data, without the null character.
-1 on error.

Example:	result = HighEdit1.GetFunctionPFDataLen ( TYP_USER + 30)

See also:	GetFunctionPFName
GetFunctionPFData
GetFunctionPFNameLen
GetFunctionPFTableCount
GetFunctionPFTyp


GetFunctionPFName

Description:	Returns the name of the input field with the type indicated. The cursor must not be located in the input field.

Function:	short GetFunctionPFName

(

short 	nTyp,

BSTR * 	pbstrBuffer

)

Parameters:	nTyp

Type of input field

pbstrBuffer

The buffer which contains data. The required buffer length must be determined first with GetFunctionPFNameLen. The string must then be initialized to this size, plus 1 byte for the null character at the end.

Result:	The number of characters copied, excluding the null character.

Example:	Determine the name of the field TYPE_CLIENT:

iLen% = HighEdit1.GetFunctionPFNameLen ( TYPE_CLIENT)
sBuffer$ = String$ (iLen% + 1, 0)
iChars% = HighEdit1.GetFunctionPFName ( TYPE_CLIENT, sBuffer$)

See also:	GetFunctionPFDataLen
GetFunctionPFData
GetFunctionPFNameLen
GetFunctionPFTableCount
GetFunctionPFTyp


GetFunctionPFNameLen

Description:	Returns the length of the name of an input field with the type indicated. The cursor must not be located in the input field.

Function:	short GetFunctionPFNameLen

(

short 	nTyp

)

Parameters:	nTyp

Type of input field

Result:	Length of the name, without null character.

-1 on error.

Example:	result = HighEdit1.GetFunctionPFNamenLen ( TYP_USER + 30)

See also:	GetFunctionPFName
GetFunctionPFData
GetFunctionPFDataLen
GetFunctionPFTableCount
GetFunctionPFTyp


GetFunctionPFTableCount

Description:	Determines the field number in the internal field table.

Function:	short GetFunctionPFTableCount

(

)

Result:	Field number in the table

Example:	result = HighEdit1.GetFunctionPFTableCount ()

See also:	GetFunctionPFName
GetFunctionPFData
GetFunctionPFNameLen
GetFunctionPFDataLen
GetFunctionPFTyp


GetFunctionPFTyp

Description:	Returns the field type of a field within the field table, with table index as input.

Function:	short GetFunctionPFTyp

(

short nIndex

)

Parameters:	nIndex

Index within the field table

Result:	Field type >= TYP_USER

0 if end of table encountered

Example:	result = HighEdit1.GetFunctionPFTyp (5)

See also:	GetFunctionPFName
GetFunctionPFData
GetFunctionPFDataLen
GetFunctionPFNameLen
GetFunctionPFTableCount


GetGap

Description:	Determines the space between columns of the current table context in 1/1000 of the current HighEdit unit (cm or inch), i.e., the space between text entries in the cells. If the current insertion point is within a table cell or at the end of a table row, then the table context corresponds to that row, i.e., the column space of that row is determined (the space is identical for all cells in a table row. If multiple table sections are selected, on the other hand, the corresponding spaces are determined and compared against each other. If all spaces are identical, that value is returned as the space. Otherwise -1 (INDEFINITE) is returned, which means that differing column spaces are present within the current table context.

To ensure that a correct table context is given, at least one of the two methods IsTableActive or IsTableSelected should have returned TRUE.

Function:	BOOL GetGap

(

short* 	pnGap

)

Parameters:	pnGap

Space between the columns

Result:	BOOL

TRUE:	Column space was successfully determined (table context was given).

FALSE:	No table context present

Example:	HighEdit1.GetGap(nGap%)

See also:	SetGap
CellDimDlg


GetHEFont

Description:	Returns the most important pieces of information about the font indicated. The corresponding font name is read directly out of the printer's device context.

Function:	BOOL GetHEFont

(

short 	nFont,

short * 	lpnHeight,

long * 	lplRgb,

short * 	lpnPitch,

short * 	lpnFamily,

BSTR * 	pbstrName

)

Parameters:	nFont

Font index; -1 for the current font.

lpnHeight

Logical font height * 4

lplRgb

Color value

lpnPitch

Character width:

DEFAULT_PITCH	Standard

FIXED_PITCH	Fixed (pitch) font

VARIABLE_PITCH	Proportional font

lpnFamily

Font family

FF_DONTCARE	Standard

FF_ROMAN	Font with serifs

FF_SWISS	Sans-serif font

FF_MODERN	Vector font

FF_SCRIPT	Script

FF_DECORATIVE	Ornamental font

pbstrName

The buffer which contains the font name. It must be at least as large as LF_FACESIZE.

Result:	BOOL

TRUE:	Information received

FALSE:	No font with the index indicated present

Example:	Dim sName as String * LF_FACESIZE
result = HighEdit1.GetFont(-1, iHeight%, rgb&, iPitch%, iFamily%, sName$)

See also:	GetStyle
SetHEFont
SetStyle
GetFontHandle
GetFontIndex


GetHyperLinkData

Description:	Returns the data which was set by SetHyperLinkData for the hyperlink specified by the ID indicated.

Function:	BOOL GetHyperLinkData

(

short 	nHypID,

BSTR* 	pbstrData1,

long* 	plData2,

long* 	plData3

)

Parameters:	nHypID

Hyperlink ID

pbstrData1,

String data

plData2

Long data

plData3

Long data

Result:	BOOL

TRUE:	Hyperlink data successfully determined.

FALSE:	Error; invalid hyperlink ID

Example:	nID% = HighEdit1.GetHyperLinkID();
nDoc% = HighEdit1.GetHyperLinkData(nID%, bstrData1%, lData2&,lData3&);
result = HighEdit1.LoadDoc ( nDoc%, FILEFORMAT_HIGHEDIT)

See also:	SetHyperLinkData
GetHyperLinkID
LoadDoc


GetHyperLinkID

Description:	Returns the ID of the hyperlink located at the current insertion point.

Function:	short GetHyperLinkID

(

)

Parameters:	None

Result:	short

Non-zero:	ID of the hyperlink

0:	Error, no hyperlink present

Example:	result = HighEdit1.GetHyperLinkID()

See also:	SetHyperLinkData
GetHyperLinkData


GetInstancePrinter

Description:	Returns the printer currently selected in HighEdit.

Function:	BOOL GetInstancePrinter

(

BSTR *	pbstrPrinter,

short 	nDefault

)

Parameters:	pbstrPrinter

Contains (after processing) the printer string in format

DEVICE, DRIVER, OUTPUT

Example: HP LaserJet III,HPPCL5MS,LPT1:

The necessary storage space for the string is automatically reserved.

nDefault

Standard printer

TRUE 	The current printer is the default printer.

FALSE 	A special printer is selected.

Result:	TRUE 	Printer was successfully determined.
FALSE 	Error while determining printer

Example:	result =HighEdit1.GetInstancePrinter (pbstrPrinter, TRUE)

See also:	SetInstancePrinter


GetLine

Description:	Copies the content of the current line into the buffer indicated. The buffer can be initialized to the required length, for example with String$ ().

Function:	short GetLine

(

BSTR *	pbstrBuffer,

short 	nMaxLen

)

Parameters:	pbstrBuffer

The buffer into which the line is to be copied.

NMaxLen

The maximum number of characters to be copied, including the null character.

Result:	Number of characters copied.

Example:	sBuffer = String$ (40, 0)
result = HighEdit1.GetLine (sBuffer, 40)

See also:	GetLineLength


GetLineCount

Description:	Returns the current line number in the document.

Function:	long GetLineCount

(

)

Result:	Line number

Example:	result = HighEdit1.GetLineCount ()


GetLineLength

Description:	Returns the length of the current line, or line indicated, in characters.

Function:	short GetLineLength

(

long 	lLine

)

Parameters:	lLine

The absolute position of the line within the text.

-1 for the current line

Result:	Line length in characters

Example:	result = HighEdit1.GetLineLength ( 3000 )

See also:	GetLine
GetPrinterLineWidth


GetPage

Description:	Returns the current page and the total number of pages.

Function:	GetPage

(

short *	lpnTextPage,

short *	lpnMaxPage

)

Parameters:	lpnTextPage

Current page on which the cursor is located

lpnMaxPage

Total number of pages in the document

Example:	HighEdit1.GetPage (iText%, iPages%)


GetPathName

Description:	Returns the path of the current file.

Function:	short GetPathName

(

BSTR *	pbstrPathName

)

Parameters:	pbstrPathName

The buffer into which the path is to be copied. The required size is determined automatically.

Result:	The length of the filename, including the null character
0 on error

Example:	result = HighEdit.GetPathName (pbstrName$)

See also:	GetFileName
SetPathName


GetPFData

Description:	Returns the content of the input field at the cursor position.

Function:	short GetPFData

(

BSTR *	pbstrBuffer

)

Parameters:	pbstrBuffer

The buffer which contains data. The required buffer size must be determined first with GetPFDataLen. The string must then be initialized to this size, plus 1 byte for the null character at the end.

Result:	The number of lines copied, including the null character.
-1 on error.

Example:	iLen% = HighEdit1.GetPFData ()

See also:	GetPFDataLen
GetPFFlags
GetPFWidth


GetPFDataLen

Description:	Returns the length of the data in an input field.

Function:	GetPFDataLen

(

)

Result:	Length of the data, without the null character.

Example:	result = HighEdit1.GetPFDataLen ()

See also:	GetPFData
GetPFFlags
GetPFWidth


GetPFFlags

Description:	Returns the attributes of the input field at the cursor position.

Function:	short GetPFFlags

(

)

Result:	Combination of the following values:

PF_VISIBLE	Show input field.

PF_EDITABLE	Input field is editable.

PF_LINEREMOVE	If the input field is not visible, the entire line will be hidden.

PF_ALIGNLEFT	Left-aligned output within the field

PF_ALIGNRIGHT 	Right-aligned output within the field. PF_FIXEDSIZE is required for this.

PF_FIXEDSIZE	The input field has a fixed width and does not adjust itself to the content.

PF_MULTILINE	The input field can be several lines long.

Example:	result = HighEdit1.GetPFFlags ()

See also:	GetPFDataLen
GetPFFlags
GetPFWidth


GetPFWidth

Description:	Determines the width of the input field at the cursor position, provided the field has a fixed width.

Function:	long GetPFWidth

(

)

Result:	Width in unit * 1000
-1 of no field, or dynamic field

Example:	result = HighEdit1.GetPFWidth ()

See also:	GetPFData
GetPFFlags
GetPFDataLen


GetPhysicalDim

Description:	Returns the width and height of the selected printer paper format.

Function:	GetPhysicalDim

(

short *	lpnWidth,

short *	lpnHeight

)

Parameters:	lpnWidth

Paper width in unit * 1000

lpnHeight

Paper height in unit * 1000

Example:	HighEdit1.GetPhysicalDim (iWidth%, iHeight%)

See also:	GetPhysicalMargins
GetPrinterLineHeight
GetPrinterLineWidth
GetPrinterDim


GetPhysicalMargins

Description:	Returns the smallest possible unprintable margins of the selected printer. Selecting smaller margins in SetMargins results in truncating characters to the left and above, since these are printed too soon.

Function:	GetPhysicalMargins

(

short *	lpnLeftMargin,

short *	lpnTopMargin

)

Parameters:	lpnLeftMargin

Unprintable margin left in unit * 1000

lpnTopMargin

Unprintable margin right in unit * 1000

Example:	HighEdit1.GetPhysicalMargins (iLeft%, iTop%)

See also:	GetPhysicalDim
GetPrinterLineHeight


GetPictureDim

Description:	Determines the dimension of the graphic at the cursor position.

Function:	BOOL GetPictureDim

(

short *	lpnWidth,

short *	lpnHeight

)

Parameters:	lpnHeight

Dimension of the graphic in x-direction, height in unit * 1000

lpnWidth

Dimension of the graphic in y-direction, width in unit * 1000

Result:	BOOL

TRUE:	Dimension successfully determined

FALSE:	No graphic present

Example:	result = HighEdit1.GetPictureDim (iWidth%, iHeight%)

See also:	SetPictureDim
GetPictureFlags
GetPictureOffset


GetPictureFlags

Description:	Determines the display attributes of the graphic at the cursor position. This can be useful, for example as a response to the PictureSelect Event.

Function:	short GetPictureFlags

(

)

Result:	Flag for display of graphic:

BMP_NONE	No graphic present

BMP_ORIGINAL	Graphic in original size

BMP_SCALE	Free scaling of the graphic

BMP_KEEPRATIO	Equal x/y scaling of the graphic

Example:	result = HighEdit1.GetPictureFlags ()

See also:	SetPictureFlags
GetPictureDim
GetPictureOffset


GetPictureOffset

Description:	Determines how much the graphic is shifted to the upper left corner. A graphic can only be moved in original size, i.e., BMP_ORIGINAL must be set.

Function:	BOOL GetPictureOffset

(

short *	lpnX,

short *	lpnY

)

Parameters:	lpnX

X-shift in unit * 1000

lpnY

Y-shift in unit * 1000

Result:	BOOL

TRUE:	Shift successfully determined

FALSE:	No graphic present

Example:	result = HighEdit1.GetPictureOffset (lpnX%, lpnY%)

See also:	SetPictureOffset
GetPictureFlags
GetPictureDim


GetPrinterCursorHeight

Description:	Returns the distance of the cursor from the beginning of the page in printer points. The first hard or automatic page break up from the cursor is used as the page beginning point. If a page break is present in the line above the cursor, the return value is thus 0.

Function:	long GetPrinterCursorHeight

(

)

Example:	result = HighEdit1.GetPrinterCursorHeight ()

See also:	GetPrinterLineWidth
GetPrinterLineHeight
GetPhysicalDim
GetPhysicalMargins


GetPrinterDC

Description:	Returns the Device Context of the default printer which is currently being used by HighEdit. The printer DC (Device Context) should then be requested if it is necessary for printing or for querying specific data from the device (for example escape command GETPRINTOFFSET). In all other cases, the Information Context only should be used. HighEdit always uses the Windows default printer. If this is not set, the page appearance may change in respect to fonts, alignment, etc. if the text is later reformatted.

Function: 	short GetPrinterDC

(

)

Result:	Handle to the printer Device Context

Example:	result = HighEdit1.GetPrinterDC ()

See also:	GetPrinterIC


GetPrinterDim

Description:	Returns the maximum width and height of the printable area on the selected paper format.

Function:	GetPrinterDim

(

short *	lpnWidth,

short *	lpnHeight

)

Parameters:	lpnWidth

Width in unit * 1000

lpnHeight

Height in unit * 1000

Example:	HighEdit1.GetPrinterDim ( lpnWidth%, lpnHeight% )

See also:	GetPhysicalDim
GetPhysicalMargins
GetPrinterDim


GetPrinterIC

Description:	Returns the Information Context of the default printer which is currently being used by HighEdit. Here you can query data, for example, or generate a printer font from a screen font. The Information Context is completely adequate for GetDeviceCaps () and for most escape commands. The Device Context is generally not necessary.

Function:	short GetPrinterIC

(

)

Result:	Handle to the printer Information Context

Example:	result = HighEdit1.GetPrinterIC ()

See also:	GetPrinterDC


GetPrinterLineHeight

Description: 	Returns the height of the current line in printer points.

Function:	long GetPrinterLineHeight

(

)

Result:	Line height in printer points

Example:	result = HighEdit1.GetPrinterLineHeight ()

See also:	GetPrinterLineWidth
GetPrinterDim
GetPhysicalDim


GetPrinterLineWidth

Description:	Determines the width of the current line in printer points.

Function:	long GetPrinterLineWidth

(

)

Result:	Line width in printer points

Example:	result = HighEdit1.GetPrinterLineWidth ()

See also:	GetPrinterLineHeight
GetPrinterCursorHeight
GetPrinterDim


GetRange

Description:	Returns the 0-based lowest and highest column and row index of the current table context. Since the context of a table must be given, at least one of the two methods IsTableActive and IsTableSelected should return TRUE.

Function:	BOOL GetRange
(

short*  	pnFirstRow

short* 	pnLastRow

short* 	pnFirstCol

short* 	pnLastCol

)

Parameters:	pnFirstRow

Index of the first row

pnLastRow

Index of the last row

pnFirstCol

Index of the last row

pnLastCol

Index of the last row

Result:	BOOL

TRUE:	Area was successfully determined.

FALSE:	Error while determining area

Example:	result = HighEdit1.GetRange(FirstRow, LastRow, FirstCol, LastCol)

See also:	GetTableRange


GetRGB

Description:	Returns an RGB color value from the font table.

Function:	long GetRGB

(

short 	nIndex

)

Parameters:	nIndex

Index in the color table; -1 for the current color

Result:	Color value or

 -1, if no color with this index is present

Example:	result = HighEdit1.GetRGB (-1)

See also:	GetColor


GetRowHeight

Description:	Determines the row height of the current table context in 1/1000 of the current HighEdit unit (cm or inch). If the current insertion point is within a table cell, then the table context corresponds to this cell, i.e., the height of that row will be determined, based on the sample below. If multiple table sections are selected, on the other hand, then the corresponding heights are determined and compared against each other. If all heights are identical, that value is returned as the result. Otherwise -1 (INDEFINITE) is returned, which means that differing row heights are present in the current table context.

The interpretation of the row height depends in principle on what height type is set. For rows of type HEIGHT_TYPE_AUTO -1 (INDEFINITE) should be returned, and the current height will be determined with GetCurRowHeight. For HEIGHT_TYPE_ATLEAST the defined minimum height is returned, and for type HEIGHT_TYPE_ABSOLUTE the defined absolute height.

To ensure that a correct table context is given, at least one of the two methods IsTableActive or IsTableSelected should have returned TRUE.

Function:	BOOL GetRowHeight

(

short* 	pnRowHeight

)

Parameters:	pnRowHeight

Row height

Result:	BOOL

TRUE:	Row height was successfully determined (table context was given).

FALSE:	No table context present

Example:	HighEdit1.GetRowHeight(nRowHeight&)

See also:	SetRowHeight
CellDimDlg
GetRowHeightType


GetRowHeightType

Description:	Determines the row height type of the current table context. If the current insertion point is within a table cell, then the table context corresponds to that row, i.e., the type of that row is determined. If multiple table sections are selected, on the other hand, the corresponding types are determined and compared against each other. If all types are identical, that value is returned as the result. Otherwise -1 (INDEFINITE) is returned, which signifies that differing row height types are present within the current table context.

Possible values are:

HEIGHT_TYPE_AUTO:	Based on the row height of the cell contents

HEIGHT_TYPE_ATLEAST:	The row has a minimum height which can be exceeded for larger amounts of text.

HEIGHT_TYPE_ABSOLUTE:	The row has a fixed height value. If the height of the cell text exceeds the height value given for the row, text which extends beyond it will be clipped off, i.e., it will not be displayed.

To ensure that a correct table context is given, at least one of the two methods IsTableActive or IsTableSelected should have returned TRUE.

Function:	BOOL GetRowHeightType

(

short* pnRowHeightType

)

Parameters:	pnRowHeightType

Row height type

Result:	BOOL

TRUE:	Row height type was successfully determined (table context was given).

FALSE:	No table context present

Example:	HighEdit1.GetRowHeightType(nRowHeightType&)

See also:	GetRowHeight
CellDimDlg
GetCurRowHeight
SetRowHeight


GetScreenFont

Description:	Returns information on the screen font indicated.

Function:	BOOL GetScreenFont

(

short 	nFont,

short * 	lpnHeight,

long * 	lplRgb,

short * 	lpnPitch,

short * 	lpnFamily,

BSTR *	pbstrName

)

Parameters:	nFont

Index in the font table; -1 for the current font

lpnHeight

Logical font height x 4

lplRgb

RGB color value

lpnPitch

Character width

DEFAULT_PITCH	Standard

FIXED_PITCH	Fixed (pitch) font

VARIABLE_PITCH	Proportional font

lpnFamily

Font family:

FF_DONTCARE	Standard

FF_ROMAN	Font with serifs

FF_SWISS	Sans-serif font

FF_MODERN	Vector font

FF_SCRIPT	Script

FF_DECORATIVE	Ornamental font

pbstrName

The buffer which contains the font name. It must be at least as large as LF_FACESIZE.

Result:	BOOL

TRUE:	Information received

FALSE:	No font with the index indicated present

Example:	sName = String$(LF_FACESIZE)
result = HighEdit1.GetScreenFont(-1, lpnHeight,lplColor,lpnPitch,lpnFamily,pbstrName)

See also:	IsScreenFont
IsScreenFontsEnabled
EnableScreenFonts


GetSelectedText

Description:	Copies the selected text into the buffer indicated. The text is terminated by a null character.

Function:	BOOL GetSelectedText

(

BSTR *	pbstrBuffer

)

Parameters:	pbstrBuffer

The buffer which contains data. The required size is determined automatically.

Result:	BOOL

TRUE:	Data copied successfully

FALSE:	Error during copy

Example:	result = HighEdit1.GetSelectedText (pbstrBuffer$)

See also:	GetSelection
SetSelection
GetSelectionStart


GetSelection

Description:	Returns the dimension of the selected area. This is independent of whether the area was selected by moving up or down from the cursor. To ensure this, the starting position of the cursor can be compared with GetSelectionStart.

Note:	This function does not consider any table contents. To consider table contents, you should use GetSelectionExt.

Function:	GetSelection

(

short *	 lpnXWidth,

long *	 lplYWidth

)

Parameters:	lpnXWidth

X-dimension. If multiple rows are selected, the X-dimension is the position of the first non-selected character in the last row selected.

lplYWidth

Y-dimension

Example:	HighEdit1.GetSelection( lpnx%, lpny&)

See also:	GetSelectedText
GetSelectionStart
SetSelection
GetSelectionExt


GetSelectionExt

Description:	Returns the dimension of the currently selected area. In contrast to GetSelection, this message also considers selections within table cells, so that the selection in table cells can be restored again using a subsequent SetSelectionExt.

If no selection is active, the current cursor position is returned as the start and end position of the selection.

Function:	BOOL GetSelectionExt

(

long* 	pnYStart,

short* 	pnXStart,

long* 	pnCellYStart,

short* 	pnCellXStart,

long* 	pnYEnd,

short* 	pnXEnd,

long* 	pnCellYEnd,

short* 	pnCellXEnd

)

Parameters:	pnYStart

Y-coordinate of the selection starting point

pnXStart

X-coordinate of the selection starting point

pnCellYStart

Y-coordinate of the selection starting point within the cell

pnCellXStart

X-coordinate of the selection starting point within the cell

pnYEnd

Y-coordinate of the selection ending point

pnXEnd

X-coordinate of the selection ending point

pnCellYEnd

Y-coordinate of the selection ending point within the cell

pnCellXEnd

X-coordinate of the selection ending point within the cell

Result:	BOOL

TRUE:	Action successful, selection was successfully determined.

FALSE:	Error

Example:	result = HighEdit1.GetSelectionExt(nYStart&, nXStart%, nCellYStart&, nCellXStart%, nYEnd&, nXEnd%, nCellYEnd&, nCellXEnd%)

See also:	SetSelectionExt
GetCursorExt
SetCursorText


GetSelectionStart

Description:	Determines the start coordinates of the current selection.

Function:	BOOL GetSelectionStart

(

short *	lpnXStart,

long *	IplYStart

)

Parameters:	lpnXStart

X-coordinate

lplYStart

Y-coordinate

Result:	BOOL

TRUE:	Selection present

FALSE:	No marking (selection) present

Example:	result = HighEdit1.GetSelectionStart ( lpnx%, lply& )

See also:	GetSelection
GetSelectedText
SetSelection


GetStyle

Description:	Returns the current font attributes.

Function	short GetStyle

(

)

Result:	Combination of the following values:

ATTR_STANDARD	Normal

ATTR_BOLD	Bold

ATTR_UNDERLINE	Underline

ATTR_ITALIC	Italic

ATTR_STRIKEOUT	Strikethrough

ATTR_SUBSCRIPT	Superscript

ATTR_SUPERSCRIPT	Subscript

Example:	result = HighEdit1.GetStyle ()

See also:	SetStyle
GetFont


GetTabCount

Description:	Returns the number of tabs and margins in the current paragraph.

Function:	short GetTabCount

(

)

Result:	Number of tabs and margins

Example:	result = HighEdit1.GetTabCount ()

See also:	GetTabList


GetTableCount

Description:	Returns the number of tables in the document

Function:	short GetTableCount

(

)

Parameters:	None

Result:	Number of tables

Example:	Query the number of tables:

Result = HighEdit1.GetTableCount()

See also:	InsertTable


GetTableRange

Description:	Returns the 0-based lowest (always 0) and highest column and row index of the table at the current cursor position. The number of columns and rows will be the difference between the maximum and minimum + 1. Since the context of a table must be given, the method IsTableActive should return TRUE.

Function:	BOOL GetTableRange
(

short*  	pnFirstRow

short* 	pnLastRow

short* 	pnFirstCol

short* 	pnLastCol

)

Parameters:	pnFirstRow

First row

pnLastRow

Last row

pnFirstCol

First column=

pnLastCol

Last column

Result:	BOOL

TRUE:	Area was successfully determined.

FALSE:	Error while determining area

Example:	result = HighEdit1.GetTableRange(FirstRow, LastRow, FirstCol, LastCol)

See also:	GetRange


GetTabList

Description:	Returns the tabs and margins of the current paragraph. The number must be determined previously with GetTabCount.

Function:	BOOL GetTabList

(

short *	lpnTabTyp,

long *	lplTabOffset

)

Parameters:	lpnTabTyp

The array which contans the tab types

TAB_LEFT	Left tab

TAB_RIGHT	Right tab

TAB_CENTER	Centered tab

TAB_DECIMAL	Decimal tab

TAB_LEFTMARGIN	Left margin

TAB_RIGHTMARGIN	Right margin

TAB_INDENT	Paragraph indent

lplTabOffset

The array which contains the position in unit * 1000

Result:	BOOL

TRUE:	Tab list determined

FALSE:	Error while creating the list

Example:	iCount% = HighEdit1.GetTabCount()
ReDim TabTyp%(iCount%)
ReDim TabOffset&(iCount%)
Success% = HighEdit1.GetTabList( TabTyp%(0), TabOffset&(0))
For i% = 0 To iCount% - 1
id% = MsgBox("Tab: " + Str$(TabTyp%(i%)) + "Offset: " + Str$(TabOffset&(i%)),MB_OK, "HighEdit")
Next i%

See also:	SetTabList
GetTabCount


GetTabWidth

Description:	Returns the default tab width.

Function:	short GetTabWidth

(

)

Result:	Tab width in unit * 1000

Example:	result = HighEdit1.GetTabWidth ()

See also:	SetTabWidth
GetTabList


GetTyp

Description:	Returns the type at the cursor position.

Function:	short GetTyp

(

)

Result:	short

TYP_TEXT:	Normal text

TYP_BITMAP:	Graphic

TYP_USER:	Input field with the type in question

Example:	result = HighEdit1.GetTyp ()

See also:	GetFunctionPFTyp


GetUndoDepth

Description:	Determines the maximum depth of the UNDO stack.

Function:	short GetUndoDepth

(

)

Result:	Maximum depth of the UNDO stack

Example:	result = HighEdit1.GetUndoDepth ()

See also:	Undo
SetUndoDepth
CanUndo
ClearUndoList
QueryUndoType


GetVersion

Description:	Returns the version number of the HighEdit kernel.

Function:	GetVersion

(

short * 	lpnMajor,

short * 	lpnMinor,

short * 	lpnInternal

)

Parameters:	lpnMajor

Main version number

lpnMinor

Two-place (minor) version number

lpnInternal

Letter for internal release

Example:	HighEdit1.GetVersion (Major%, Minor%, Internal%)


HEUndo

Description:	Undoes one or more actions on the UNDO stack, up to the index passed. The index begins at 0 here as well, so that an action is undone is 0 is passed.

Function:	BOOL HEUndo

(

short 	nIndex

)

Parameters:	nIndex

The index, up to and including which actions are to be undone.

Result:	BOOL

TRUE:	Action was successfully undone.

FALSE:	Error or no action present

Example:	result =HighEdit1.HEUndo (2)

See also:	QueryUndoType
SetUndoDepth


HideDropDown

Description:	Closes an open Combobox in the IconBar.

Function:	HideDropDown

(

)

Example:	HighEdit1.HideDropDown ()


HyperLinkColorDlg

Description:	Dialog box for setting the hyperlink color

Function:	BOOL HyperlinkColorDlg

(

)

Result:	BOOL

TRUE:	Color was set.

FALSE:	Dialog box was canceled.

Example:	result = HighEdit1.HyperLinkColorDlg ()

See also:	ColorDlg


InitNewDoc

Description:	Initializes a new document.

Function:	InitNewDoc

(

)

Example:	HighEdit1.InitNewDoc ()


InsertBitmap

Description:	Inserts a new graphic in Windows Bitmap format at the cursor position. The graphic can be changed in size after it is inserted.

Function:	BOOL InsertBitmap

(

long	nBitmap

)

Parameters:	nBitmap

Windows Bitmap handle

Result:	BOOL

TRUE:	Insertion successful

FALSE:	Error during insertion

Example:	Picture = LoadPicture("c:\win31\pyramid.bmp")
HighEdit1.InsertBitmap( Picture )

See also:	GetPictureDim
SetPictureDim
LoadPicture


InsertBookMark

Description:	Inserts a new text mark at the current insertion point. CanInsertBookMark should be used first to check whether this is possible.

Function:	short InsertBookMark

(

)

Parameters:	None

Result:	short

Non-zero:	The ID of the new text mark. This ID can be used at a later time to jump back to this text mark, using HE_MOVETO.

0:	Error while inserting text mark

Example:	result = HighEdit1.InsertBookMark()

See also:	CanInsertBookMark
CanRemoveBookMark
RemoveBookMark


InsertFunctionPF

Description:	Inserts an input field of the type indicated at the cursor position. The field settings are set to (PF_VISIBLE Or PF_EDITABLE Or PF_FUNCTION). If other settings are used at the time of insertion, you must use ExtInsertFunctionPF.

Function:	BOOL InsertFunctionPF

(

short 	nTyp,

BSTR 	pszText

)

Parameters:	nTyp

Type of input field

pszText

The string which displays the function of the input field

Result:	BOOL

TRUE:	Insertion successful

FALSE:	Error during insertion

Example:	result = HighEdit1.InsertFunctionPF ( TYP_USER + 30, "Data")

See also:	DeletePF
AddFunctionPF
ChangeFunctionPF
ExtInsertFunctionPF


InsertHyperLink

Description:	Inserts a new hyperlink at the current insertion point. CanInsertHyperLink should be used first to check whether this can be done.

Function:	short InsertHyperLink

(

)

Result:	short

Non-zero:	The ID of the inserted hyperlink

0:	Hyperlink cannot be inserted.

Example:	result = HighEdit1.InsertHyperLink()

See also:	CanInsertHyperLink
CanRemoveHyperLink
RemoveHyperLink


InsertTable

Description:	Inserts a table into the text at the current cursor position. For this to be performed successfully, no table context should be active, i.e., the method IsTableActive should have returned FALSE.

Function:	BOOL Insert Table

(

short	nRows

short	nCols

)

Parameters:	nRows

Row number

nCols

Number of columns

Result:	BOOL

TRUE:	Table was successfully inserted.

FALSE:	Error while inserting the table

Example:	result := HighEdit1.InsertTable(5,10)

See also:	InsertTableRow
AppendTableRow


InsertTableCell

Description:	Inserts a table cell before the current cursor position. In order for this to be performed successfully, a table context should be active, i.e. the IsTableActive method should have returned TRUE.

Function:	BOOL InsertTableCell

(

)

Parameters:	None

Result:	BOOL

TRUE:	Table cell was successfully inserted.

FALSE:	Error while inserting the table column

Example:	result = HighEdit1.InsertTableCell()

See also:	DeleteTableCell
AppendTableCell


InsertTableColumn

Description:	Inserts a table column before the current cursor position. In order for this to be performed successfully, a table context should be active, i.e. the IsTableActive method should have returned TRUE.

Function:	BOOL InsertTableColumn

(

)

Parameters:	None

Result:	BOOL

TRUE:	Table column was successfully inserted.

FALSE:	Error while inserting the table column

Example:	result = HighEdit1.InsertTableColumn()

See also:	DeleteTableColumn
AppendTableColumn


InsertTableRow

Description:	Inserts a table row before the current cursor position. In order for this to be performed successfully, a table context should be active, i.e. the IsTableActive method should have returned TRUE.

Function:	BOOL InsertTableRow

(

)

Parameters:	None

Result:	BOOL

TRUE:	Table row was successfully inserted.

FALSE:	Error while inserting the table row

Example:	result = HighEdit1.InsertTableRow()

See also:	DeleteTableRow
AppendTableRow


IsCellActive

Description:	Determines whether a table cell is active, i.e., whether the current insertion point is located within a table cell.

Function:	BOOL IsCellActive

(

)

Parameters:	None

Result:	BOOL

TRUE:	Table cell active

FALSE:	No table cell active

Example:	result = HighEdit1.IsCellActive()

See also:	IsTableActive
IsTableSelected


IsClearDelete

Description:	Determines whether the marked (selected) area will be deleted or moved to temporary storage when it is removed.

Function:	BOOL IsClearDelete

(

)

Result:	BOOL

TRUE:	Area is deleted.

FALSE:	Area is moved to temporary storage.

Example:	result = HighEdit1.IsClearDelete ()

See also:	Clear
Cut
SetClearDelete


IsFormfeed

Description:	Determines whether a hard page break is located within the current row.

Function:	BOOL IsFormfeed

(

)

Result:	BOOL

TRUE:	Page break present

FALSE:	No page break present

Example:	result = HighEdit1.IsFormfeed ()

See also:	ToggleFormfeed


IsHeadFootVisible

Description:	Determines whether the internal header and footer windows are currently being displayed.

Function:	BOOL IsHeadFootVisible

(

)

Parameters:	None

Result:	BOOL

TRUE:	Headers and footers are displayed.

FALSE:	Hide headers and footers.

Example:	result = HighEdit1.IsHeadFootVisible()

See also:	ShowHeadFoot


IsIgnoreEditable

Description:	Determines whether non-editable lines can be edited normally by global settings.

Function:	BOOL IsIgnoreEditable

(

)

Result:	BOOL

TRUE:	Non-editable lines are editable.

FALSE:	Non-editable lines remain non-editable.

Example:	result = HighEdit1.HighEdit1.IsIgnoreEditable ()

See also:	SetIgnoreEditable


IsLineEditable

Description:	Determines whether the current line is editable.

Function:	BOOL IsLineEditable

(

)

Result:	BOOL

TRUE: 	The line is editable.

FALSE: 	The line is not editable.

Example:	result = HighEdit1.IsLineEditable ()

See also:	SetLineEditable


IsModified

Description:	Determines whether changes have been made to the text since the last save.

Function:	BOOL IsModified

(

)

Result:	BOOL

TRUE:	Text has been changed.

FALSE:	Text has not been changed.

Example:	result = HighEdit1.IsModified ()

See also:	SetModified


IsPercentThumb

Description:	Determines whether the percent display in the scroll bar is turned on or off.

Function:	BOOL IsPercentThumb

(

)

Result:	BOOL

TRUE:	Percent display is turned on.

FALSE:	Percent display is turned off.

Example:	result = HighEdit1.IsPercentThumb ()

See also:	SetPercentThumb


IsPFActive

Description:	Determines whether an input field is open. Most messages have no effect on open input fields, since input always has to be terminated first. An open input field can be closed with CloseActivePF.

Function:	BOOL IsPFActive

(

)

Result:	BOOL

TRUE:	An input field is open.

FALSE:	No input field is open.

Example:	result = HighEdit1.IsPFActive ()

See also:	CloseActivePF


IsPreview

Description:	Determines whether the print preview is active.

Function:	BOOL IsPreview

(

)

Result:	BOOL

TRUE:	Print preview is active.

FALSE:	Print preview is not active.

Example:	result =HighEdit1.IsPreview()

See also:	Preview


IsScreenFont

Description:	Determines whether the font that was passed is a screen font.

Function:	BOOL IsScreenFont

(

short 	nIndex

)

Parameters:	nIndex

Index in the font table; -1 for the current font

Result:	BOOL

TRUE:	The font is a screen font.

FALSE:	The font is a printer font.

Example:	result = HighEdit1.IsScreenFont(-1)

See also:	GetScreenFont


IsScreenFontsEnable

Description:	Determines whether screen fonts are available.

Function:	BOOL IsScreenFontsEnable

(

)

Result:	BOOL

TRUE:	Screen fonts are available.

FALSE:	Only printer fonts are available.

Example:	result = HighEdit1.IsScreenFontsEnabled()

See also:	EnableScreenFonts


IsSelection

Description:	Determines whether a selection is currently active. This may also be located within a table cell. In the case of an active selection, GetTextSel can then be used to copy, for example.

Function:	BOOL IsSelection

(

)

Parameters:	None

Result:	BOOL

TRUE:	Selection is active.

FALSE:	No selection is active.

Example:	result = HighEdit1.IsSelection()


IsTableActive

Description:	Determines whether a table is active, i.e., whether the current insertion point is either within a table cell or at the end of a table row (i.e. after the last cell).

Function:	BOOL IsTableActive

(

)

Parameters:	None

Result:	BOOL

TRUE:	Table active

FALSE:	No table active

Example:	result = HighEdit1.IsTableActive()

See also:	IsCellActive
IsTableSelected


IsTableSelected

Description:	Determines whether parts of one or more tables are currently selected (marked).

Function:	BOOL IsTableSelected

(

)

Parameters:	None

Result:	BOOL

TRUE:	Parts of one or more tables are selected.

FALSE:	No parts of tables are selected.

Example:	result = HighEdit1.IsTableSelected()

See also:	IsTableActive
IsCellActive


LinkCells

Description:	Links all currently selected table cells together in one row. In order for this to be performed successfully, the current selection should include parts of tables such as cells, entire rows or complete tables, i.e., the message IsTableSelected should have returned TRUE.

Function:	BOOL LinkCells

(

)

Parameters:	None

Result:	BOOL

TRUE:	Cells were successfully joined together.

FALSE:	Error while joining the cells.

Example:	result = HighEdit1.LinkCells()

See also:	SplitCells
SplitCellsDlg


LoadDlg

Description:	Creates a File Open Dialog Box. A selected file is taken directly into HighEdit. Any text which is present is deleted.

Function:	BOOL LoadDlg

(

)

Result:	BOOL

TRUE:	File was opened.

FALSE:	Cancel or error while opening file.

Example:	result = HighEdit1.LoadDlg ()

See also: 	AppendDlg
SaveDlg
LoadDoc


LoadDoc

Description:	Open a document. A previously existing document is overwritten.

Function:	BOOL LoadDoc

(

BSTR 	lpszFileName,

short 	nFormat

)

Parameters:	pszFileName

Complete file name with path and extension

nFormat

The format of the file

FILEFORMAT_HIGHEDIT	Specific format including all information

FILEFORMAT_ANSI	All ASCII-ANSI text

FILEFORMAT_OEM	All ASCII-OEM text

FILEFORMAT_RTF	Text in Rich-Text format

Result:	BOOL

TRUE:	File successfully opened

FALSE:	Error while opening file

Example:	result = HighEdit1.LoadDoc ( "TEST.HED", FILEFORMAT_HIGHEDIT)

See also:	LoadDlg
SaveDoc


LoadInfoDlg

Description:	A Dialog box for opening a file. A selected file is taken directly into HighEdit. Any text which is present is deleted. In contrast to LoadDlg, this dialog box also displays the document information for HED files which can be edited with DocInfoDlg.

Function:	BOOL LoadInfoDlg

(

)

Result:	BOOL

TRUE:	File was opened.

FALSE:	Cancel or error while opening file

Example:	result = HighEdit1.LoadInfoDlg ()

See also:	DocInfoDlg
LoadDlg


LoadPicture

Description:	Loads a graphic into the text at the cursor position.

Function:	BOOL LoadPicture

(

BSTR 	lpszFileName,

short 	nFormat

)

Parameters:	lpszFileName

Complete file name with path and extension

nFormat

Format of the graphic

FILEFORMAT_BITMAP	Windows Bitmap BMP

FILEFORMAT_PCX	PCX Graphic

FILEFORMAT_GIF	GIF Graphic

FILEFORMAT_TIFF	TIFF Graphic

FILEFORMAT_TARGA	TARGA Graphic

FILEFORMAT_WMF	Windows Metafile WMF

Result:	BOOL

TRUE:	Graphic successfully opened

FALSE:	Error while opening graphic

Example:	result = HighEdit1.LoadPicture ("ABC.BMP",FILEFORMAT_BITMAP)

See also:	PictureDlg
InsertBitmap


MoveTo

Description:	This new, universal navigation message offers a wide range of possibilities for navigating within a HighEdit document, for example to the next character, to the third table, to the text mark with ID 17, and so forth.

Function:	BOOL MoveTo

(

short 	nFlags,

long	lValue

)

Parameters:	nFlags

A combination of no more than one value of the following 3 categories (category 1 is required; for categories 2 and 3, MT_ABSOLUTE and MT_NOSELECT are used as defaults):

Category 1 - object

MT_XPOS:	The character position within the current row (table cells are counted as 1 character).

MT_YPOS:	Text row

MT_CHAROFFSET:	Character position, with consideration for the content of table cells (can be determined at any time by HE_GETCHAROFFSET).

MT_TABLE:	Table

MT_ROW:	Table row

MT_COLUMN:	Table column

MT_BOOKMARK:	Text mark

Category 2 - mode

MT_ABSOLUTE:	Absolute entry

MT_RELATIVE:	Relative to the current cursor position

MT_ID:	ID entry (currently only in combination with MT_BOOKMARK)

Category 2 - selection

MT_NOSELECT:	No marking (selection)

MT_SELECT:	With marking (selection)

lValue

The evaluation of this parameter depends on the entries of categories 1 and 2 in wParam.

MT_XPOS | MT_ABSOLUTE: 	0-based character position within the current row

MT_XPOS | MT_RELATIVE:	The number of characters within the current row to the left (negative) or right

MT_YPOS | MT_ABSOLUTE:	0-based row number within the document

MT_YPOS | MT_RELATIVE:	The number of rows up (negative) or down

MT_CHAROFFSET | MT_ABSOLUTE:	0-based character number within the document, with consideration of the contents of table cells.

MT_CHAROFFSET | MT_RELATIVE: 	The number of characters towards the beginning of the document (negative) or the end of the document

MT_TABLE | MT_ABSOLUTE:	0-based table number within the document

MT_TABLE | MT_RELATIVE:	The number of tables up (negative_ or down

MT_ROW | MT_ABSOLUTE:	0-based index of table rows within the current table

MT_ROW | MT_RELATIVE:	The number of table rows up (negative) or down

MT_COLUMN | MT_ABSOLUTE:	0-based index of the table cell within the current table row

MT_COLUMN | MT_RELATIVE:	The number of cells within the current table row to the left (negative) or the right

MT_BOOKMARK | MT_ABSOLUTE:	0-based text mark number within the document

MT_BOOKMARK | MT_RELATIVE:	The number of text marks up (negative) or down

MT_BOOKMARK | MT_ID:	The ID of the text mark (see InsertBookMark )

Result:	BOOL

TRUE:	Action performed successfully

FALSE:	Error

Example:	1) Jump to the 1st table in the document

HighEdit1.MoveTo MT_TABLE Or MT_ABSOLUTE, 1

2) Jump to the text mark with ID 171

HighEdit1.MoveTo MT_BOOKMARK Or MT_ID, 171

See also:	GetCharOffset


NextPF

Description:	Searches for the next input field.

Function:	short NextPF

(

short 	nFlags,

short 	nLevel,

short * 	lpnTypList

)

Parameters:	nFlags

One or more of the following flags:

NEXTPF_BACKWARD 	Backward search

NEXTPF_FORWARD	Forward search

NEXTPF_ONLYEDITABLE 	Only editable fields found

NEXTPF_ONLYVISIBLE	Only visible fields found

NEXTPF_FILEENDSTOP	The search is ended when the end of the text is encountered.

nLevel

For later development only; must be set to -1.

lpnTypList

A field consisting of integers with the field types that are to be found. The first element of the field contains the number of types which follow. The first element must be passed when a call is made.

Result:	The type of the input field found.
0 if no field was found.

Example:	A search will be made for fields of type CLIENT and PROSPECT.

ReDim TypList (3)
TypList (0) = 2
TypList (1) = TYP_CLIENT
TypList (2) = TYP_PROSPECT
Typ% = HighEdit1.NextPF(
NEXTPF_FORWARD Or
NEXTPF_ONLYVISIBLE,
-1, TypList (0) )

See also:	ChangeFunctionPF
AddFunctionPF
DeletePF


Paginate

Description:	Performs a page break through the entire text. Places where a new page should begin are displayed with a dotted line. The page breaks are not moved down if changes are made, and thus become invalid. This function must then be called again as needed. If internal headers and footers are used, they will be taken into consideration.

Function:	Paginate

(

)

Example:	HighEdit1.Paginate()

See also:	FormatDoc


ParagraphDlg

Description:	A dialog box for specifying paragraph format and tabs. The entire tab list is read upon opening and displayed in a ComboBox. All numerical values will be expected in centimeters or inches.

Function:	BOOL ParagraphDlg

(

)

Result:	BOOL

TRUE:	Format was set.

FALSE:	Cancel

Example:	result = HighEdit1.ParagraphDlg ()


Paste

Description:	Inserts text from the clipboard at the cursor position.

Function:	Paste

(

)

Example:	HighEdit1.Paste()

See also:	PasteData
PasteRTF
Copy
CopyRTF


PasteData

Description:	Inserts text with attributes and formatting at the current cursor position. If the format handle hFormat in the structure that was passed as a parameter = 0, then this message corresponds to ReplaceSel with wParam = 0, except that instead of the GlobalHandle for text transfer, a pointer to the text which is to be inserted is used directly. The GlobalHandles in the parameter structure can be created with CopyData.

Function:	BOOL PasteData

(

BSTR * 	pbstrFormat,

BSTR *	pbstrText,

long 	lFormatLength

)

Parameters:	pbstrFormat

Buffer with formatting

pbstrText

Text buffer

lFormatLength

Number of characters

Result:	BOOL

TRUE:	Text was successfully inserted.

FALSE:	Error while inserting text

Example:	success% = HighEdit1.CopyData(sFormat,SText)
nLang = Len(sFormat)
result = HighEdit1.PasteData ( pbstrFormat$,pbstrText$,nFormatLength%)

See also:	PasteDataGlobalMem
CopyData
Paste
PasteRTF
CopyRTF
CanCopy
CanPaste


PasteDataGlobalMem

Description:	Inserts a text segment with attributes and formatting at the cursor position. The GlobalHandles must be created with CopyDataGlobalMem ().

Function:	BOOL PasteDataGlobalMem

(

long 	lFormat,

long 	lText

BOOL 	bFreeFomat

BOOL 	bFreeText

)

Parameters:	nFormat

Handle of the buffer with formatting

nText

Handle of the text buffer

bFreeFormat

Frees up memory allocated for the formatting.

bFreeText

Frees up memory allocated for the text.

TRUE	Memory is freed up.

FALSE	Memory is not freed up.

Result:	BOOL

TRUE:	Text was successfully inserted.

FALSE:	Error while inserting text

Example:	result = HighEdit1.CopyDataGlobalMem (nFormat&, nText&)
result = HighEdit1.PasteDataGlobalMem (nFormat&, nText&,TRUE,TRUE)

See also:	PasteData
Paste
CopyDataGlobalMem


PasteRTF

Description:	Inserts a text segment in RTF format at the cursor position.

Function:	BOOL PasteRTF

(

BSTR 	sRTF

)

Parameters:	sRTF

The string which contains the RTF text.

Result:	BOOL

TRUE:	RTF text successfully inserted

FALSE:	Error during insertion

Note:	In VB 4.0, the maximum length of strings is 64 kB. To process larger quantities of data, you will need to access global Windows memory. This processing can then be performed with HEPasteRTFGlobalMem().

Example:	result = HighEdit1.CopyRTF(sTextRTF)
result = HighEdit1.PasteRTF(sTextRTF)

See also:	CopyRTF
PasteRTFGlobalMem
Paste
PasteData
PasteDataGlobalMem


PasteRTFGlobalMem

Description:	Inserts a text segment in RTF format at the cursor position. The text must be available in a global Windows memory area to insert more than 64kB of data.

Function:	BOOL PasteRTFGlobalMem

(

long 	lRTF,

BOOL 	bFree

)

Parameters:	lRTF

The global handle which contains the RTF text

bFree

TRUE	The allocated memory is freed up.

FALSE	The allocated memory is not freed up.

Result:	BOOL

TRUE:	RTF text successfully inserted

FALSE:	Error during insertion

Example:	result = HighEdit1.CopyRTFGlobalMem (iRTF%)
result = HighEdit1.PasteRTFGlobalMem (iRTF%,TRUE)

See also:	CopyRTFGlobalMem
PasteRTF
Paste
PasteData
PasteDataGlobalMem


PictureDlg

Description:	A Dialog box for opening graphics. A selected graphic is inserted into the HighEdit text at the cursor position. The graphic can be previewed within the dialog box.

Function:	BOOL PictureDlg

(

)

Result:	BOOL

TRUE:	Graphic was inserted.

FALSE:	Cancel or error while inserting graphic

Example:	result = HighEdit1.PictureDlg ()


Preview

Description:	Turns the print preview on or off.

Function:	Preview

(

)

Result:	None

Example:	HighEdit1.Preview()

See also:	IsPreview


PrintDlg

Description:	A dialog box for printing documents. The printer can still be selected at this point. Calling the Print Setup Dialog Box directly from this box changes the printer settings directly in the HighEdit indicated. Since print changes are also for a particular instance, this concerns all the HighEdit windows of this application. After the dialog box is confirmed with OK, the entire document is printed out.

 Function:	BOOL PrintDlg

(

)

Result:	BOOL

TRUE:	Print will take place.

FALSE:	Cancel

Example:	result =HighEdit1.PrintDlg ()

See also:	PrintDoc


PrintDoc

Description:	Prints the current text. If internal headers and footers are being used, they will also be printed. The events PrintHead and PrintFoot will be initiated to facilitate printing them.

Function:	PrintDoc

(

)

Example:	HighEdit1.PrintDoc()

See also:	PrintDlg
PrintDocAbortDlg
PrintDocParamAbortDlg


PrintDocAbortDlg

Description:	Prints the current text while displaying a 'Cancel' dialog box. If internal headers and footers are being used, they will also be printed. The events PrintHead and PrintFoot will be initiated to facilitate printing them.

Function:	BOOL PrintDocAbortDlg

(

BSTR 	lpszDocTitle,

short 	nPageCounter

)

Parameters:	lpszDocTitle

Document title

nPageCounter

Starting value of the page counter

Result:	BOOL

TRUE:	Print OK

FALSE	Print process was canceled.

Example:	HighEdit1.PrintDocAbortDlg("Test", 1)

See also:	PrintDoc
PrintDlg
PrintDocParamAbortDlg


PrintDocParamAbortDlg

Description:	Prints the current text while displaying a 'Cancel' dialog box. If internal headers and footers are being used, they will also be printed. The events PrintHead and PrintFoot will be initiated to facilitate printing them.

Function:	BOOL PrintDocParamAbortDlg

(

short 	nStartPage,

short 	nEndPage,

BSTR 	lpszDocTitle,

short 	nPageCounter

)

Parameters:	nStartPage

The page on this the printing is to begin. 0 if from beginning of the text.

nEndPage

The last page to be printed. 0 if up to text end.

lpszDocTitle

Document title

nPageCounter

Starting value of the page counter

Result:	BOOL

TRUE:	Print OK

FALSE:	Print process was canceled.

Example:	result = HighEdit1.PrintDocParamAbortDlg( 3, 5, "Test", 3)

See also:	PrintDoc
PrintDlg
PrintDocAbortDlg


PrintDocParamHwndAbortDlg

Description:	Prints the current text with external headers and footers and displays a 'Cancel' dialog box. If internal headers and footers are being used, the external ones take precedence.

Function:	BOOL PrintDocParamHwndAbortDlg

(

short 	nStartPage,

short 	nEndPage,

long 	lHead,

long 	lFoot.

BSTR 	lpszDocTitle,

short 	nPageCounter

)

Parameters:	nStartPage

The page on which the printing is to begin. 0 if from beginning of the text.

nEndPage

The last page to be printed. 0 if up to text end.

lHead

The handle of the HighEdit child which contains the header. The handle must be determined with GetActiveHighEdit().

lFoot

The handle of the HighEdit child which contains the footer. The handle must be determined with GetActiveHighEdit().

lpszDocTitle

Document title

nPageCounter

Starting value of the page counter

Result:	BOOL

TRUE:	Print OK

FALSE:	Print process was canceled.

See also:	PrintDoc
PrintDlg
PrintDocAbortDlg


PrintInsertDoc

Description:	Prints a header or footer text in the available printer DC (Device Context) or main window. The DC (Device Context) and the rectangle are transferred with PrintHead or PrintFoot and are thus directly accessible. This function is used mainly to print external headers and footers.

Function:	PrintInsertDoc

(

long 	hdcPrinter,

short 	x1,

short 	y1,

short 	x2,

short 	y2

)

Parameters:	hdcPrinter

Printer DC (Device Context)

x1, y1 / x2, y2

Rectangle available for the text

Example:	Sub HighEdit_PrintHead (hdcPrinter , x1 , y1 , x2 , y2 , NoInternalPrint )
HighEdit1.PrintInsertDoc (hdcPrinter, x1, y1, x2, y2
NoInternalPrint = TRUE
End Sub

See also:	PrintDoc
PrintDlg
PrintDocAbortDlg
PrintDocParamHwndAbortDlg


PrintSetupDlg

Description:	Dialog box for setting up the printer. The changed printer settings are changed directly in the HighEdit indicated. Since print changes always take place for a particular instance, this concerns all HighEdit windows in this application.

Function:	BOOL PrintSetupDlg

(

)

Result:	BOOL

TRUE:	Printer settings have been set.

FALSE:	Cancel

Example:	result =HighEdit1.PrintSetupDlg ()


QueryUndoType

Description:	Determines the type of action on the UNDO stack according to the index passed. The first action has the index 0.

Function:	long QueryUndoType

(

short	nIndex

)

Parameters:	nIndex

Index to the UNDO stack

Result:	Type of action:

UNDO_NONE	No action is present with the index that was passed.

UNDO_CHARINSERT	One or more characters have been entered.

UNDO_CHARDELETE	Character deleted with Delete key.

UNDO_LINEINSERT	New row was added with Enter key.

UNDO_BACKSPACE	Character deleted with Backspace key.

UNDO_LINEDELETE	Row was deleted with Delete or Backspace key.

UNDO_BLOCKCUT	Selected area was cut.

UNDO_BLOCKPASTE	Section was inserted from the clipboard.

UNDO_BLOCKCLEAR	Selected section was deleted.

Example:	result = QueryUndoType()

See also:	Undo
CanUndo
GetUndoDepth
SetUndoDepth


QuickReplace

Description:	Inserts data from the current row from the cursor position. The data are taken without checking, so that only plain text can be overwritted with this function. Other data could lead to mutilation of the text.

Function:	BOOL QuickReplace

(

BSTR 	lpszText,

short 	nLen

)

Parameters:	lpszText

Data string

nLen

Length of the data

Result:	BOOL

TRUE:	Data inserted

FALSE:	Row is too small to receive data.

Example:	result = HighEdit.QuickReplace ("Text", 4)

See also:	ReplaceSel


Redraw

Description:	Results in a redisplay of the window contents.

Function:	Redraw

(

 BOOL 	bClear

)

Parameters:	bClear

TRUE	Window is previously deleted.

FALSE	Window is not deleted.

Example:	HighEdit1.Redraw (TRUE)

See also:	ReplaceSel


RemoveBookMark

Description:	Deletes text mark(s) contained at the current insertion point or in the current selection. CanRemoveBookMark should be used first to check whether a corresponding context has been indicated.

Function:	BOOL RemoveBookMark

(

)

Parameters:	None

Result:	BOOL

TRUE:	Text mark(s) successfully deleted

FALSE:	No text mark(s) present

Example:	result = HighEdit1.RemoveBookMark()

See also:	CanInsertBookMark
InsertBookMark
CanRemoveBookMark


RemoveHyperLink

Description:	Deletes hyperlink(s) contained at the current insertion point or in the current selection. CanRemoveHyperLink should be used first to check whether a corresponding context has been indicated.

Function:	BOOL RemoveHyperLink

(

)

Parameters:	None

Result:	BOOL

TRUE:	Hyperlink(s) successfully deleted

FALSE:	No hyperlinks present

Example:	result = HighEdit1.RemoveHyperLink()

See also:	CanRemoveHyperLink
CanInsertHyperLink
InsertHyperLink


ReplaceDlg

Description:	A dialog box for searching for and replacing an expression.

Function:	short ReplaceDlg

(

)

Result:	0	Cancel

1	Replace

2	Replace all

Example:	result = HighEdit1.ReplaceDlg ()

See also:	SearchDlg


ReplaceSel

Description:	Replaces the selected text segment with the new text that was entered.

Function:	BOOL ReplaceSel

(

BSTR 	pszText,

short 	nTextWidth

)

Parameters:	pszText

New text, which must be terminated by a null character. Individual lines must be separated by CR/LF.

nTextWidth

Length of the string

Result:	BOOL

TRUE:	Text successfully replaced

FALSE:	Error while replacing text

Example:	result = HighEdit1.ReplaceSel ("Text", 4)

See also:	QuickReplace


SaveAsDlg

Description:	A dialog box for saving text present in HighEdit. This dialog box is always called, even if the text has already been saved once.

Function:	SaveAsDlg

(

)

Result:	BOOL

TRUE:	File was saved.

FALSE:	Cancel or error while saving the file.

Example:	result = HighEdit1.SaveAsDlg ()

See also:	SaveDlg


SaveDlg

Description:	A dialog box for saving text present in HighEdit.

Note:	If the current document already has a file name, no dialog box is displayed. If you always want a dialog box to be presented, you should use SaveAsDlg.

Function:	BOOL SaveDlg

(

)

Result:	BOOL

TRUE:	File was saved.

FALSE:	Cancel or error while saving the file.

Example:	result = HighEdit1.SaveDlg ()

See also:	LoadDlg
SaveAsDlg
SaveDoc


SaveDoc

Description:	Saves the current document.

Function:	BOOL SaveDoc

(

BSTR  	pszFileName,

short 	nFormat

)

Parameters:	pszFileName

Complete file name with path and extension

nFormat

The format of the file:

FILEFORMAT_HIGHEDIT	Specific format including all information

FILEFORMAT_ANSI	All ASCII-ANSI text

FILEFORMAT_OEM	All ASCII-OEM text

FILEFORMAT_RTF	Text in Rich-Text format

Result:	BOOL

TRUE:	File was successfully saved.

FALSE:	Error while saving file

Example:	result = SaveDoc ("C:\TEST.HED", FILEFORMAT_HIGHEDIT)

See also:	SaveDlg
LoadDoc


Search

Description:	Searches for a segment of text which corresponds to the search expression provided. If the text segment has been found, the cursor is positioned at the beginning of the segment, which is marked (selected) to the end. The first time a call is made with a new search expression, SEARCH_INIT must absolutely be indicated. Otherwise, if SEARCH_INIT is omitted, searching may continue with the old search expression. Additional searching starts from the previously found text.

Function:	short Search

(

short 	nFlags,

BSTR 	pszText,

short 	nDisplayError

)

Parameters:	nFlags

One or more of the following flags:

SEARCH_FORWARD	Forward search

SEARCH_CASE	Ignore upper/lower case

SEARCH_WORD	Find only entire words.

SEARCH_CURSOR	Begin the search from the cursor position.

SEARCH_BACK	Backward search

SEARCH_INIT	Initializes a new search expression.

pszText

The search expression can contain a question mark '?' to stand for one character, or an asterisk '*' to stand for multiple characters. The asterisk can stand for up to 10 characters, and may occur only once in the search expression. To search for * or ?, enter the character twice in a row.

nDisplayError

Indicates whether or not a dialog box should be displayed for errors or search expressions not found.

TRUE	Dialog box is displayed.

FALSE	No dialog box

Result:	short

SEARCH_NOTFOUND	Text not found

SEARCH_FOUND	Text found

SEARCH_ERROR	Error in the search expression

Example:	result = HighEdit1.Search ( SEARCH_FORWARD + SEARCH_CASE, "Hello", TRUE)

See also:	SearchContinue
SearchDlg


SearchContinue

Description:	Searches for a search expression again. The additional search is possible only if the search expression was previously found. The flag SEARCH_INIT must not be indicated. The additional search always begins at the previously found text.

Function:	short SearchContinue

(

short 	nDisplayError

)

Parameters:	nDisplayError

Indicates whether or not a dialog box should be displayed for errors or search expressions not found.

TRUE	Dialog box is displayed.

FALSE	No dialog box

Result:	short

SEARCH_NOTFOUND	Text not found

SEARCH_FOUND	Text found

SEARCH_ERROR	Additional search not possible

Example:	result = HighEdit1.SearchContinue (TRUE)

See also:	Search
SearchDlg


SearchDlg

Description:	A dialog box for searching for an expression. If the expression was found, the cursor is positioned at the beginning of the expression, which is marked (selected).

Function:	BOOL SearchDlg

(

)

Result:	BOOL

TRUE:	Expression found

FALSE	Expression not found

Example:	result =HighEdit1.SearchDlg ()


SelectAll

Description:	Marks the content of the current table cell or the entire text, independently of the parameter wParam and the current table context.

Function:	BOOL SelectAll

(

BOOL 	bTable

)

Parameters:	bTable

TRUE:	Marks the content of the currently active table cell. Can be used only if the insertion point is within a table cell (see IsCellActive).

FALSE:	Marks the entire document

Result:	BOOL

TRUE:	Text successfully selected

FALSE:	No text to mark present

Example:	result = HighEdit1.SelectAll (True)

See also:	SetSelection
SelectWord
ReplaceSel
IsCellActive


SelectTable

Description:	Selects the table in which the current insertion point is located. To ensure that a correct table context is given, the message IsTableActive should have returned TRUE.

Function:	BOOL SelectTable

(

)

Parameters:	None

Result:	BOOL

TRUE:	Table successfully selected (table context was given).

FALSE:	No table context present

Example:	result = HighEdit1.SelectTable()

See also:	SelectTableRow
SelectTableCell


SelectTableCell

Description:	Selects the currently active table cell or the table cell in front of which the current insertion point is located. To ensure that a correct table context is given, the message IsCellActive should have returned TRUE.

Function:	BOOL SelectTableCell

(

)

Parameters:	None

Result:	BOOL

TRUE:	Table cell successfully selected (table context was given).

FALSE:	No table context present

Example:	result = HighEdit1.SelectTableCell()

See also:	SelectTable
SelectTableRow


SelectTableRow

Description:	Selects the table row in which the current insertion point is located. To ensure that the corresponding table context is given, the message IsTableActive should have returned TRUE.

Function:	BOOL SelectTableRow

(

)

Parameters:	None

Result:	BOOL

TRUE:	Table row was successfully selected (table context was given).

FALSE:	No table context present

Example:	result = HighEdit1.SelectTableRow()

See also:	SelectTable
SelectTableCell


SelectWord

Description:	The word in which the cursor is currently located is selected.

Function:	BOOL SelectWord

(

)

Result:	BOOL

TRUE:	Word successfully selected

FALSE:	No word found to select

Example:	result = HighEdit1.SelectWord ()

See also:	SelectAll
SelectWord


SendMessage

Description:	Sends a message directly to the HighEdit child. To send a message to a specific window, use the SendMessageEx function.

Function:	long SendMessage

(

short 	nMessage,

short 	nParam,

long 	lParam

)

Parameters:	nMessage

HighEdit or Windows message

nParam

WPARAM for this message

lParam

LPARAM for this message

Result:	Return value of the message

Example:	result = HighEdit1.SendMessage ( WM_SETREDRAW, FALSE, 0)

See also:	SendMessageEx


SendMessageEx

Description:	Sends a message directly to a given window.

Function:	long SendMessageEx
(

long 	lWindowHandle,

short 	nMessage,

long 	lWParam,

long 	lLParam

)

Parameters:	lWindowHandle

Window handle

nMessage

HighEdit or Windows message

nParam

WPARAM of the Windows message

lParam

LPARAM of the Windows message

Result:	Return value of the message

Example:	result = HighEdit1.SendMessageEx (GetActiveMenuBar, WM_SETREDRAW, FALSE, 0)


SetAllPFFlags

Description:	Searches through the entire text for all input fields of the given type and makes the field settings indicated.
Note: If all input fields in the text are to be set to PF_MULTILINE, this must be replaced with a loop by NextPF and AddPFFFlags.

Function:	BOOL SetAllPFFlags

(

short 	nFlags,

short 	nLevel,

short * 	lpnTypList

)

Parameters:	nFlags

One or more of the following flags:

PF_VISIBLE	Show input field.

PF_EDITABLE	Input field is editable.

PF_LINEREMOVE	If the input field is not visible, the entire line will be hidden.

PF_ALIGNLEFT	Left-aligned output within the field

PF_ALIGNRIGHT	Right-aligned output within the field. PF_FIXEDSIZE is required for this.

PF_FIXEDSIZE	The input field has a fixed width and does not adjust itself to the content.

PF_FUNCTION	Must absolutely be set, since there is otherwise no more access to the data.

nLevel

For later development only; must be set to -1.

lpnTypList

Field of integers with the field types that were found. The first element of the field contains the number of types which follow. The first element must be passed when a call is made.

Result:	BOOL

TRUE:	New settings made

FALSE:	Error while settings were being made

Example:	Set flag PF_VISIBLE for fields of type CLIENT and PROSPECT:

ReDim TypList (3)
TypList (0) = 2
TypList (1) = TYP_CLIENT
TypList (2) = TYP_PROSPECT
Success% = HighEdit1.SetAllPFFlags (
PF_VISIBLE + PF_FUNCTION, -1,
TypList (0) )

See also:	GetPFFlags
SetPFFlags
SetAllPFWidth


SetAllPFWidth

Description:	Searches through the entire text for all input fields of the given type and sets the field width, as long as the field has a fixed width.

Function:	SetAllPFWidth

(

short 	nWidth,

short * 	lpnTypList

)

Parameters:	nWidth

New width in unit * 1000

lpnTypList

A field consisting of integers with the field types that are to be found. The first element of the field contains the number of types which follow. The first element must be passed when a call is made.

Example:	ReDim TypList (3)
TypList (0) = 2
TypList (1) = TYP_CLIENT
TypList (2) = TYP_PROSPECT
Success% = HighEdit1.SetAllPFWidth (2000,TypList (0))

See also:	SetPFWidth
SetAllPFFlags


SetBorder

Description:	Sets the border attributes style, line thickness and color of the current table context. If the current insertion point is within a table cell, then the table context corresponds to this cell i.e., the border attributes of that cell are set. If multiple table sections are selected, on the other hand (several cells, entire rows or complete tables), the change to the border affects the entire selection.

The field nBorderPos in the structure passed as a parameter can be used to take a bitwise OR of constants BORDER_POS_LEFT, ..._TOP, ..._RIGHT, ..._BOTTOM, ..._HORIZONTAL and ..._VERTICAL to control access to variously positioned borders. To set all the borders in a table context, use the constant BORDER_POS_ALL.

Note that for setting border attributes, the following applies in general: If a negative value is specified for a field (INDEFINTIE = -1), then that attribute of the table context will remain unchanged. This makes it possible to set the color to red without changing the style and line thickness (nBorderStyle = INDEFINITE, nPenWidth = INDEFINITE, crColor = RGB( 255, 0, 0 ) ).

To ensure that a correct table context is given, at least one of the two methods IsCellActive or IsTableSelected should have returned TRUE.

Function:	BOOL SetBorder

(

short 	nBorderPos,

short 	nBorderStyle,

short 	nPenWid,

long 	lColor

)

Parameters:	nBorderPos:

Takes a bitwise OR of constants BORDER_POS_LEFT, ..._TOP, ..._RIGHT, ..._BOTTOM, ..._HORIZONTAL and ..._VERTICAL to control access to variously positioned borders. The constant BORDER_POS_ALL is available for access to ALL borders.

nBorderStyle:

Specifies the border style; can take on values BORDER_STYLE_NONE, ..._HAIR, ..._SINGLE, ..._DOUBLE, ..._DOT, ..._DASH, ..._SHADOW and INDEFINITE (= -1).

nBorderStyle:

Specifies the border style; can take on values BORDER_STYLE_NONE, ..._HAIR, ..._SINGLE, ..._DOUBLE, ..._DOT, ..._DASH, ..._SHADOW and INDEFINITE (= -1).

nPenWidth:

Specifies line thickness in Twips. Note as a point of reference that 15 Twips corresponds to the style BORDER_STYLE_HAIR (hairline).

lColor:

Specifies the color as an RGB value.

Result:	BOOL

TRUE:	Border attributes successfully set (table context was given).

FALSE:	No table context present

Example:	Double border on the left side with 20 Twips in red:

HighEdit1.SetBorder(BORDER_POS_LEFT, BORDER_STYLE_DOUBLE, 20, 255);

See also:	GetBorder
BorderDlg


SetCell3D

Description:	Sets the 3D-effect of current table context. If the current insertion point is located within a table cell, then the table context corresponds to that cell, i.e., the 3D-effect of that cell will be set. If multiple table sections are selected, on the other hand (several cells, a whole row or complete tables), then the change will affect the entire selection.

To ensure that a correct table context is given, one of the two messages IsCellActive or IsTableSelected should have returned TRUE.

Function:	BOOL SetCell3D

(

short nCell3D

)

Parameters:	nCell3D

The 3D-effect to be set. Possible values are:

INDEFINITE:	The call will be ignored.

_3D_NONE:	No 3D-effect

_3D_POPIN:	Sunken display

_3D_POPOUT:	Raised display

Result:	BOOL

TRUE:	3D-effect successfully set (table context was given).

FALSE:	No table context present

Example:	result = HighEdit1.SetCell3D(_3D_POPIN)

See also:	GetCell3D
SetBorder
SetCellShading
BorderDlg


SetCellShading

Description:	Sets the background shading of the current table context. If the current insertion point is located within a table cell, then the table context corresponds to that cell, i.e., the shading of that cell will be set. If multiple table sections are selected, on the other hand (several cells, a whole row or complete tables), then the change will affect the entire selection.

If the field nShading of the structure that was passed is negative, then the call will be ignored.

To ensure that a correct table context is given, one of the two messages IsCellActive or IsTableSelected should have returned TRUE.

Function:	BOOL SetCellShading

(

short 	nShading,

long 	lForeColor,

long 	lBackColor

)

Parameters:	nShading

Shading

lForeColor

RGB display of the foreground color

lBackColor

RGB display of the background color

Result:	BOOL

TRUE:	Background shading successfully set (table context was given).

FALSE:	No table context present

Example:	result = HighEdit1.SetCellShading(5000, 125, 255)

See also:	SetCell3D
GetCellShading
SetBorder
BorderDlg


SetClearDelete

Description:	Turns deletion of selected sections on or off when the DELETE key is pressed.

Function:	SetClearDelete

(

BOOL 	bClear

)

Parameters:	bClear

TRUE	Area is deleted.

FALSE	Area is moved to temporary storage.

Example:	HighEdit1.SetClearDelete (TRUE)

See also:	IsClearDelete
Clear


SetColumnWidth

Description:	Sets the column width of the current table context in 1/1000 of the current HighEdit unit (cm or inch). If the current insertion point is located within a table cell, then the table context corresponds to that cell, i.e., the cell width will be set. If multiple table sections are selected, on the other hand, then the new width will be set for all selected cells. If a negative value is passed as the new width (INDEFINITE = -1), then the call will be ignored.
To ensure that a correct table context is given, at least one of the two methods IsTableActive or IsTableSelected should have returned TRUE.

Function:	BOOL SetColumnWidth

(

short 	nWidth

)

Parameters:	nWidth

Column width

Result:	BOOL

TRUE:	Column width successfully set (table context was given).

FALSE:	No table context present

Example:	HighEdit1.SetRowHeight(15);

See also:	GetColumnWidth
CellDimDlg


SetContext

Description:	Determines which HighEdit window will contain messages when headers and footers are visible. By default, the window which has the focus will contain messages. Messages to HighEdit may then in some cases be redirected to the header or footer window. The context should only be changed for a short period of time, and must be set back to the original value again after processing. In no case should the focus be changed.

Function:	short SetContext

(

short 	nContext

)

Parameters:	nContext

CONTEXT_MAIN	Main HighEdit contains messages.

CONTEXT_HEAD	Header HighEdit contains messages.

CONTEXT_FOOT	Footer HighEdit contains messages.

Result:	Previously set context

Example:	result = HighEdit1.SetContext (CONTEXT_MAIN)

See also:	GetContext


SetCursor

Description:	Moves the cursor to the column and row indicated. If the column or row indicated is outside the visible region, the new text region will be visible.

Note: 	This function does not consider any table contents. To consider table contents, use SetCursorExt.

Function:	BOOL SetCursor

(

short 	nXNew,

long 	lYNew

)

Parameters:	nXNew

New column in characters

nYNew

New row absolute to the entire text

Result:	BOOL

TRUE:	Cursor successfully positioned

Example:	result = HighEdit1.SetCursor (0, 200)

See also:	GetCursor
CursorHome
CursorEnd
SetCursorExt


SetCursorExt

Description:	Positions the cursor within the document. In contrast to SetCursor, this message also supports positioning within table cells.

Function:	BOOL SetCursorExt

(

long 	nYAbs,

short 	nXAbs,

long 	nCellYAbs,

short 	nCellXAbs,

BOOL 	bSelect

)

Parameters:	nYAbs

Y-position

nXAbs

X-position

nCellYAbs

Y-position within the cell

nCellXAbs

X-position within the cell

bSelect

TRUE: A selection is created, starting with the previous position.

Result:	BOOL

TRUE:	Action performed successfully

FALSE:	Error

Example:	result = HighEdit1.SetCursorExt (0, 200, 20, 50, )

See also:	GetCursorExt
GetSelectionExt
SetSelectionExt


SetEOFChar

Description:	Sets the text end character.

Function:	K SetEOFChar

(

short 	nChar

)

Parameters:	nChar

Character code in range >= 32 AND <= 255 AND NOT 127

Example:	HighEdit1.SetEOFChar(65)

See also:	GetEOFChar


SetFileName

Description:	Sets the current file name without the path.

Function:	SetFileName

(

BSTR 	lpszFileName

)

Parameters:	lpszFileName

Filename with extension, but without path

Example:	HighEdit1.SetFileName("TEST.HED")

See also:	GetFilename
SetPathName


SetGap

Description:	Sets the space between columns of the current table context in 1/1000 of the current HighEdit unit (cm or inch), i.e., the space between text entries in the cells. If the current insertion point is located within a table cell or at the end of a table row, then the table context corresponds to that cell, i.e., the column space of that row will be set (the space is identical for all cells of a table row). If multiple table sections are selected, on the other hand, then the space of all the rows will be set. If a negative value (INDEFINITE = -1) is passed as the new space, then the call will be ignored.
To ensure that a correct table context is given, at least one of the two methods IsTableActive or IsTableSelected should have returned TRUE.

Function:	BOOL SetGap

(

short nGap

)

Parameters:	nGap

New column space in 1/1000 of the current HighEdit unit (cm or inch).

Result:	BOOL

TRUE:	Column space successfully set 	(Table context was given)

FALSE:	No table context present

Example:	HighEdit1.SetGap(nGap)

See also:	GetGap
CellDimDlg


SetHEFont

Description:	Sets a new font in HighEdit. If FONT_SET_ALL is not used, then remaining information from the current font will be used.

Function:	BOOL SetHEFont

(

short 	nHeight,

long 	lRgb,

short 	nPitch,

short 	nFamily,

BSTR 	lpszName,

short 	nMode

)

Parameters:	nHeight

Logical font height x 4

Rgb

RGB color value

nPitch

Character width:

DEFAULT_PITCH	Default

FIXED_PITCH	Fixed (pitch) font

VARIABLE_PITCH	Proportional font

nFamily

Font family:

FF_DONTCARE	Default

FF_ROMAN	Font with serifs

FF_SWISS	Sans-serif font

FF_MODERN	Vector font

FF_SCRIPT	Script

FF_DECORATIVE	Ornamental font

lpszName

Font name

nMode

Determines what should be set. Any combination of the following values:

FONT_SET_STYLE	Attributes will be set.

FONT_SET_COLOR	Color will be set.

FONT_SET_NAME	Font name will be set.

FONT_SET_SIZE	Font height will be set.

FONT_SET_ALL	New font will be accepted in its entirety.

Result:	BOOL

TRUE:	Font successfully generated

FALSE:	Error while generating font

Example:	result = HighEdit1.SetHEFont (80, 0, DEFAULT_PITCH, FF_SWISS, "Arial", FONT_SET_NAME Or FONT_SET_STYLE)

See also:	GetFont
SetStyle


SetHyperLinkData

Description:	Defines additional data for the hyperlink specified by the ID given. The data can be used determined later by using GetHyperLinkData. This information is saved as part of the document.

Function:	BOOL SetHyperLinkData

(

short 	nHypID,

BSTR 	lpData1,

long 	lData2,

long 	lData3

)

Parameters:	nHypID

Hyperlink ID

pbstrData1,

String data

plData2

Long data

plData3

Long data

Result:	BOOL

TRUE:	Hyperlink data set successfully.

FALSE:	Error; invalid hyperlink ID

Example:	nID% = GetHyperLinkID;
result = HighEdit1.SetHyperLinkData(nID%, c:\test\test1.hed, 3, 5);

See also:	GetHyperLinkData
GetHyperLinkID


SetGrayBk

Description:	Sets background to gray.

Function:	SetGrayBk

(

BOOL	bGrayBk

)

Parameters:	bGrayBk

TRUE:	Gray background

FALSE:	Original background is restored.


SetIgnoreEditable

Description:	Sets the global setting that makes non-editable lines to be editable like normal lines. This is useful for making changes to text without having to set all protected sections back to non-editable again individually.

Function:	SetIgnoreEditable

(

BOOL 	bIgnoreEditable

)

Parameters:	bIgnoreEditable

TRUE	Non-editable lines may be edited.

FALSE	Non-editable lines remain non-editable.

Example:	HighEdit1.SetIgnoreEditable(TRUE)

See also:	IsIgnoreEditable


SetInstancePrinter

Description:	Sets a printer all HighEdit windows of this application instance.

Function:	BOOL SetInstancePrinter

(

BSTR 	pszPrinter

)

Parameters:	pszPrinter

The string which contains the desired printer, in the format:

DEVICE, DRIVER, OUTPUT

Example: HP LaserJet III,HPPCL5MS,LPT1:

If an empty string is passed, the default printer will be determined and used.

Result:	BOOL

TRUE:	Indicated printer successfully set

FALSE:	Error while opening indicated printer

Example:	result = HighEdit1.SetInstancePrinter("HP Laserjet III,HPPCL5MS,LPT1")

See also:	GetInstancePrinter
PrintSetupDlg


SetLineEditable

Description:	Sets the current line to editable or non-editable.

Function:	SetLineEditable

(

BOOL 	bEditable

)

Parameters:	bEditable

TRUE 	Line becomes editable.

FALSE 	Line becomes non-editable.

Example:	HighEdit1.SetLineEditable(TRUE)

See also:	IsLineEditable
GetLine


SetModified

Description:	Sets or deletes code that indicates whether text has been changed since last save. The code can be queried with IsModified ().

Function:	SetModified

(

BOOL 	bModified,

)

Parameters:	bModified

TRUE	Code will be set.

FALSE	Code will be deleted.

Example:	HighEdit1.SetModified (FALSE)

See also:	IsModified


SetOffset

Description:	Sets the distance of the text display to the left or right margin of the window.

Function:	SetOffset

(

short 	nXOffset,

short 	nYOffset,

BOOL 	bUpdate

)

Parameters:	nXOffset

X-distance in screen points

nYOffset

Y-distance in screen points

bUpdate

TRUE	Update text display

FALSE	No redraw

Example:	HighEdit1.SetOffset(10, 10, TRUE)


SetPageCounter

Description:	Sets the page counter in the Cancel dialog box to the value indicated.

Function:	SetPageCounter

(

short 	nPageCounter

)

Parameters:	nPageCounter

Page counter

Example:	HighEdit1.SetPageCounter (5)

See also:	PrintDocAbortDlg
GetPage


SetPathName

Description:	Sets the current path without the filename.

Function:	SetPathName

(

BSTR 	pszPathName

)

Parameters:	pszPathName

Complete path without filename

Example:	HighEdit1.SetPathName ("C:\WIN31\SYSTEM\")

See also:	GetPathName
SetFileName
GetFileName


SetPercentThumb

Description:	Turns the percent display on or off. By default, the display is turned on.

Function:	SetPercentThumb

(

BOOL 	bPercentThumb

)

Parameters:	bPercentThumb

TRUE	Scroll bar with percent display

FALSE	Scroll bar without percent display

Example:	HighEdit1.SetPercentThumb(FALSE)

See also:	IsPercentThumb


SetPFFlags

Description:	Sets the attributes for the input field at the cursor position.

Function:	BOOL SetPFFlags

(

short 	nFlags

)

Parameters:	nFlags

Attributes which can contain the following values (also in combination):

PF_VISIBLE	Show input field.

PF_EDITABLE	Input field is editable.

PF_LINEREMOVE	If the input field is not visible, the entire line will be hidden.

PF_ALIGNLEFT	Left-aligned output within the field

PF_ALIGNRIGHT	Right-aligned output within the field. PF_FIXEDSIZE is required for this.

PF_FIXEDSIZE	The input field has a fixed width and does not adjust itself to the content.

PF_MULTILINE	The input field can be several lines long.

Result:	BOOL

TRUE:	New settings replaced

FALSE:	No input field present at the cursor position

See also:	GetPFFlags
SetAllPFFlags


SetPFWidth

Description:	Sets the width of the input field at the cursor position, as long as the field has a fixed width.

Function:	BOOL SetPFWidth

(

short 	nWidth

)

Parameters:	nWidth	New width in unit * 1000

Result:	BOOL

TRUE:	Field width set

FALSE:	No field present

Example:	result = HighEdit1.SetPFWidth (3000)

See also:	GetPFWidth


SetPictureDim

Description:	Sets the width and height of a graphic at the cursor position.

Function:	BOOL SetPictureDim

(

short 	nWidth

short 	nHeight

)

Parameters:	nWidth

Width in unit * 1000

nRight

Height in unit * 1000

Result:	BOOL

TRUE:	Dimension successfully set

FALSE:	Error while setting dimension

Example:	result = HighEdit1.SetPictureDim (5000, 3500)

See also:	GetPictureDim
SetPictureFlags


SetPictureFlags

Description:	Sets the display attributes of the graphic at the cursor position.

Function:	BOOL SetPictureFlags

(

short 	nFlags

)

Parameters:	nFlags

BMP_ORIGINAL	Graphic in original size

BMP_SCALE	Free scaling of the graphic

BMP_KEEPRATIO	Equal x/y scaling of the graphic

Result:	BOOL

TRUE:	Attributes successfully set

FALSE:	Error while setting attributes

Example:	result = HighEdit1.SetPictureFlags (BMP_SCALE)

See also:	GetPictureFlags
SetPictureDim
SetPictureOffset


SetPictureOffset

Description:	Sets the offset to the upper left corner by which the graphic will be moved. The shift will only have an effect on graphics in original size, i.e. with BMP_ORIGINAL.

Function:	BOOL SetPictureOffset

(

short 	nxOffset,

short 	nyOffset

)

Parameters:	nxOffset

X-shift in unit * 1000

nyOffset

Y-shift in unit * 1000

Result:	BOOL

TRUE:	Shift made successfully.

FALSE:	Error while setting shift

Example:	result = HighEdit1.SetPictureOffset (1000, 500)

See also:	GetPictureOffset
SetPictureFlags
SetPictureDim


SetRedraw

Description:	Turns screen display on and off. After switching the screen display, the window content will be redrawn.

Function:	SetRedraw

(

short 	nRedraw

)

Parameters:	nRedraw

TRUE	Screen display on

FALSE	Screen display off

Example:	HighEdit1.SetRedraw (FALSE)

See also:	Redraw


SetRowHeight

Description:	Sets the row height and the height type of the current table context in 1/1000 of the current HighEdit unit (cm or inch). If the current insertion point is located within a table cell, then the height and type of that row will be set. If multiple table sections are selected, on the other hand, then the new height with the new type will be set for all rows which contain the selected cells.

If a negative value is passed for the new height (INDEFINITE = -1), then the height entry used up until then is retained and only the new type is set. But if a negative value or a value greater than HEIGHT_TYPE_ABSOLUTE is passed for the new type, then the current height type is kept and only the height will be set. If both values are negative, the call will be ignored.

The interpretation of the height entry depends mainly on the height type. The height entry is ignored for type HEIGHT_TYPE_AUTO; for type HEIGHT_TYPE_ATLEAST the entry is interpreted as minimum height; for type HEIGHT_TYPE_ABSOLUTE as the absolute height.
To ensure that a correct table context is given, at least one of the two methods IsTableActive or IsTableSelected should have returned TRUE.

Function:	BOOL SetRowHeight

(

short 	nRowHeightType,

short 	nRowHeight

)

Parameters:	nRowHeightType

New height type

nRowHeight

New row height in 1/1000 of the current HighEdit unit (cm or inch).

Result:	BOOL

TRUE:	Row height and type successfully set (table context was given).

FALSE:	No table context present

Example:	HighEdit1.SetRowHeight(nRowHeightType, nRowHeight);

See also:	GetRowHeight
GetCurRowHeight
GetRowHeightType
CellDimDlg


SetSelection

Description:	Selects the text from the cursor position up to the column and row indicated. For negative values, selection is from the cursor position upward, and for the values 0,0 the selection is deleted.

Note:	SetSelection does not consider table contents. To consider table contents, use SetSelectionExt.

Function:	BOOL SetSelection

(

short 	nXWidth,

long 	lYWidth

)

Parameters:	nXWidth

If only one row is selected: the number of characters to be selected.

If multiple rows are selected: the column in the last row which is the first one NOT to be selected.

lYWidth

The number of rows to be selected.

Result:	BOOL

TRUE:	Text successfully selected

FALSE:	Error while selecting

Example:	result = HighEdit1.SetSelection (0, -5)

See also:	SelectAll
GetSelection
SetSelectionEditable
SetSelectionExt


SetSelectionEditable

Description:	Sets all rows in the selected section to editable or non-editable.

Function:	BOOL SetSelectionEditable

(

BOOL 	bEditable

)

Parameters:	bEditable

TRUE	Rows become editable.

FALSE 	Rows become non-editable.

Result:	BOOL

TRUE:	Row parameters set

FALSE:	No selected section present

Example:	result = HighEdit1.SetSelectionEditable (TRUE)


SetSelectionExt

Description:	Selects a text section. In contrast to SetSelection, either the starting or ending position can be given for this message. Selections within table cells are supported as well.

Function:	BOOL SetSelectionExt

(

long nYStart,

short nXStart,

long nCellYStart,

short nCellXStart,

long nYEnd,

short nXEnd,

long nCellYEnd,

short nCellXEnd

)

Parameters:	nYStart

Y-coordinate of the selection starting point

nXStart

X-coordinate of the selection starting point

nCellYStart

Y-coordinate of the selection starting point within the cell

nCellXStart

X-coordinate of the selection starting point within the cell

nYEnd

Y-coordinate of the selection ending point

nXEnd

X-coordinate of the selection ending point

nCellYEnd

Y-coordinate of the selection ending point within the cell

nCellXEnd

X-coordinate of the selection ending point within the cell

Result:	BOOL

TRUE:	Action successful, section was selected.

FALSE:	Error

Example:	result = HighEdit1.SetSelectionExt ()

See also:	GetSelectionExt
GetSelection
SetCursorText


SetStyle

Description:	Sets the current font attributes and font color.

Function:	BOOL SetStyle

(

short 	nAttribute,

long 	lColor

)

Parameters:	nAttribute

One or more of the following attributes:

ATTR_STANDARD	Normal

ATTR_BOLD	Bold

ATTR_UNDERLINE	Underline

ATTR_ITALIC	Italic

ATTR_STRIKEOUT	Strikethrough

ATTR_SUBSCRIPT	Superscript

ATTR_SUPERSCRIPT 	Subscript

CURRENT_ATTRIBUTE	No change to the attributes

lColor

New RGB color value of the type. If CURRENT_COLOR is used, the font color is unchanged.

Result:	BOOL

TRUE:	Action successful

FALSE:	New attributes cannot be created.

Example:	result = HighEdit1.SetStyle (ATTR_BOLD, RGB_RED)

See also:	GetStyle
SetHEFont


SetTabList

Description:	Sets the tabs and margins in the current paragraph. The first 3 fields must be the left margin, the paragraph indent and the right margin. All following tabs must be entered into the array with increasing offsets.

Function:	BOOL SetTabList

(

short 	nCount,

short * 	lpnTabTyp,

long * 	lplTabOffset

)

Parameters:	nCount

Number of tabs and margins

lpnTabTyp

The array which contains the tab types

TAB_LEFT	Left tab

TAB_RIGHT	Right tab

TAB_CENTER	Centered tab

TAB_DECIMAL	Decimal tab

TAB_LEFTMARGIN	Left margin

TAB_RIGHTMARGIN	Right margin

TAB_INDENT	Paragraph indent

lplTabOffset

The array which contains the position in unit * 1000

Result:	BOOL

TRUE:	Tab list set

FALSE:	Error while setting the list

Example:	ReDim TabTyp%(5)
ReDim TabOffset&(5)

TabTyp%(0) = TAB_LEFTMARGIN
TabOffset&(0) = 2000
TabTyp%(1) = TAB_INDENT
TabOffset&(1) = 1000
TabTyp%(2) = TAB_RIGHTMARGIN
TabOffset&(2) = 15000
TabTyp%(3) = TAB_LEFT
TabOffset&(3) = 5500
TabTyp%(4) = TAB_DECIMAL
TabOffset&(4) = 7500

Success% = HighEdit1.SetTabList(5,TabTyp%(0), TabOffset&(0))

See also:	GetTabList
ParagraphDlg


SetTabWidth

Description:	Sets the default tab width.

Function:	SetTabWidth

(

short 	nTabWidth

)

Parameters:	nTabWidth

Width in unit * 1000

Example:	HighEdit1.SetTabWidth(1500)

See also:	GetTabWidth
ParagraphDlg
SetTabList


SetUndoDepth

Description:	Sets the maximum depth of the UNDO stack. If the stack is full and a new action has to be accepted, then the oldest action is deleted from the stack. The default value for a new stack is 10 actions.

Function:	SetUndoDepth

(

short 	nMaxDepth

)

Parameters:	nMaxDepth

Maximum depth of the UNDO stack. The value must be greater than 0. If the value given is less than the previous one, then the actions that have become superfluous will be deleted.

Result:	None

Example:	HighEdit1.SetUndoDepth(7)

See also:	Undo
CanUndo
SetUndoDepth
ClearUndoList
QueryUndoType


ShowHeadFoot

Description:	Turns the display of internal header and footer windows on or off.
A prerequisite for this is property HeadFoot = TRUE.

Function:	BOOL ShowHeadFoot

(

BOOL	bShow

)

Parameters:	bShow

TRUE	Show header/footer

FALSE	Hide header/footer

Result:	BOOL

TRUE:	Success

FALSE:	No internal headers/footers present

Example:	result% = HighEdit1.ShowHeadFoot(TRUE)


SplitCells

Description:	Splits the cells currently included in the table context. If the current insertion point is located within a table cell, then the table context corresponds to that cell, i.e., that cell will be split. If multiple table sections are selected, on the other hand, then all selected cells will be split.

To ensure that a correct table context is given, one of the two messages IsCellActive or IsTableSelected should have returned TRUE.

Function:	BOOL SplitCells

(

short 	nCells

)

Parameters:	nCells

The number of cells in which table cells are to be split up. Valid values range from 2 to 32.

Result:	BOOL

TRUE:	Cell(s) successfully split

FALSE:	Error while spitting cell(s)

Example:	result = HighEdit1.SplitCells(2)

See also:	LinkCells
SplitCellsDlg


SplitCellsDlg

Description:	Activates the dialog box Split Cells, which allows for input of the number of cells into which each of the cells contained in the current table context are to be split. After confirmation of the dialog box, the division will be carried out. If the current insertion point is located within a table cell, then the table context corresponds to that cell, i.e., that cell will be split. If multiple table sections are selected, on the other hand, then all selected cells will be split.

To ensure that a correct table context has been given, one of the two methods IsCellActive or IsTableSelected should have returned TRUE.

Function:	BOOL SplitCellsDlg

(

)

Parameters:	None

Result:	BOOL

TRUE:	The dialog box was confirmed, and the cells were successfully split.

FALSE:	The dialog box was canceled, or an error occurred while the cells were being split up.

Example:	result = HighEdit1.SplitCellsDlg()

See also:	LinkCells
SplitCells


TableInsertDlg

Description:	Inserts a table into the text at the current cursor position. For this to be performed successfully, no table context should be active, i.e., the method IsTableActive should have returned FALSE.

Function:	TableInsertDlg

(

)

Parameters:	None

Result:	None

Example:	result := HighEdit1.InsertTable()

See also:	InsertTableRow
AppendTableRow


ToggleFormfeed

Description:	Inserts an additional page break after the current row, or deletes one that is already present.

Function:	BOOL ToggleFormfeed

(

)

Result:	BOOL

TRUE:	Row contains a page break.

FALSE:	The row contains no page break.

Example:	result = HighEdit1.ToggleFormfeed ()

See also:	IsFormfeed


WinIniChange

Description:	Informs HighEdit that the system parameters have been changed. Visual Basic does not currently support any system messages. For this reason, this is handled internally in the HighEdit interface, so that this function is generally not necessary.
If the printer is changed at HighEdit runtime, this function will be required.
Note: In VB, the parameter (lParam) must be defined as a string. This string must contain "windows" when the call is made. This causes HighEdit to search in the [windows] section of WIN.INI for the default printer.

Function:	WinIniChange

(

long 	lParam

)

Parameters:	lParam

lParam that is used in the Windows message

Result:	None


WriteProfile

Description:	Writes the current settings in the INI file and makes these settings the default settings when HighEdit starts. The INI file is created in the Windows root directory. In OCX, the default name selected is HIGHEDIT.INI.
The following settings are saved:

Font name, font type, font size and font color
Screen font
Conversion unit (2540 for centimeters, 1000 for inches).
Tab width
Margins and text dimension
Insert/overwrite mode
Line break
Gray background
Visible input fields, tabs, spaces, line breaks
Show field function.
Display hidden input fields, rows.

Note:	This function will only work if the property Profile is set. The settings will also be taken into the runtime properties.

Function:	BOOL WriteProfile

(

)

Result:	BOOL

TRUE:	Settings successfully saved

FALSE:	Error while saving settings

Example:	result = HighEdit1.WriteProfile ()


Properties

Properties are characteristics of a Control which can be manipulated at design time or at runtime.

HighEdit behaves like any other Control in this respect. The default properties, (Left,Right,Width, etc.) are described in detail in the Manual in the appropriate development environment. They will not be listed here.

The following properties can be manipulated at design time or runtime.

BookMarkColor

BookMarksVisible

BottomMargin

FieldBkColor

FieldsVisible

FunctionsVisible

GhostField

GhostLine

GridLines

HeadFoot

HorScrollBar

HyperLinkColor

HyperLinksNotify

HyperLinksVisible

LeftMargin

LineAlign

LineBreak

LineSpacing

MenuBar

PicturesAsFrame

Profile

ReadOnly

ReturnsVisible

RightMargin

Ruler

SpacesVisible

StatusBar

StyleBar

TabsVisible

Tab

TextSelectable

TextToWindow

TopMargin

Undo

Unit

VerScrollBar


BookMarkColor

Description:	Default Color for Bookmarks

If a change is made at runtime, all existing bookmarks will be displayed in the new color.

Type:	long

Values:	Color in RGB display

Default:	RGB(0,0,255) blue


BookMarksVisible

Description:	Show/hide bookmarks.

Type:	BOOL

Values:	TRUE	Show bookmarks.
FALSE	Hide booksmarks

Default:	TRUE


BottomMargin

Description:	Lower margin

Type:	float

Values:	Lower margin in the current unit (Unit)


FieldBkColor

Description:	Sets the background color of all input fields to the value indicated.

Type:	long

Values:	RGB color value from the standard Windows palette

Default:	RGB(255,255,255) white


FieldsVisible

Description:	Shows or hides input fields.

Type:	BOOL

Values:	TRUE	Show input fields.
FALSE	Hide input fields

Default:	TRUE


FunctionsVisible

Description:	Show field functions or field content.

Type:	BOOL

Values:	TRUE	Show field function.
FALSE	Show field content

Default:	FALSE


GhostField

Description:	Display invisible input fields in outline.

Type:	BOOL

Values:	TRUE	Outline display
FALSE	Hide field.

Default:	FALSE


GhostLine

Description:	Display lines hidden from input fields

Type:	BOOL

Values:	TRUE	Display row
FALSE	Hide row

Default:	FALSE


GridLines

Description:	Determines whether grid lines will be hidden in the tables.

Type:	BOOL

Values:	TRUE	Show grid lines
FALSE	Hide

Default:	TRUE


HeadFoot

Description:	Opens 2 additional windows for working with headers and footers when HighEdit starts. These windows can then be saved in a HighEdit file.
This property cannot ba changed at runtime.

Type:	BOOL

Values:	TRUE	Display headers/footers
FALSE	Default display

Default:	TRUE


HorScrollBar

Description:	Horizontal scroll bar

Type:	BOOL

Values:	TRUE	Show
FALSE	Hide

Default:	TRUE


HyperLinkColor

Description:	Default color for hyperlinks

When a change is made at runtime, all existing hyperlinks will be displayed in the new color.

Type:	long

Values:	Color in RGB display

Default:	RGB(0,128,0) green


HyperLinksNotify

Description:	Hyperlinks notify the HyperLinkClicked event.

Type:	BOOL

Values:	TRUE	Notify of hyperlinks.
FALSE	Do not notify of hyperlinks.

Default:	TRUE


HyperLinksVisible

Description:	Show/hide hyperlinks.

Type:	BOOL

Values:	TRUE	Show hyperlinks.
FALSE	Hide hyperlinks.

Default:	TRUE


LeftMargin

Description:	Left margin

Type:	float

Values:	Left margin in the current unit (Unit)


LineAlign

Description:	Determines the row alignment (right, left, centered, justify).

Type:	short

Values:	ALIGN_LEFT 	(0)
ALIGN_RIGHT 	(1)
ALIGN_CENTER 	(2)
ALIGN_JUSTIFY 	(3)

Default:	ALIGN_LEFT


LineBreak

Description:	Use automatic line break

Type:	BOOL

Values:	TRUE	Autom. line break on
FALSE	Autom. line break off

Default:	TRUE


LineSpacing

Description:	Line spacing

Type:	short

Values:	SPACING_ONE 	(0)
SPACING_ONEHALF 	(1)
SPACING_DOUBLE 	(2)

Default:	SPACING_ONE


MenuBar

Description:	Turns the MenuBar within the OCX Control on and off.

Type:	BOOL

Values:	TRUE	Show MenuBar.
FALSE	Hide MenuBar.

Default:	TRUE


PicturesAsFrame

Description:	Pictures are displayed as an empty frame (speeds up display rate).

Type:	BOOL

Values:	TRUE	Pictures as frame
FALSE	Pictures displayed as original

Default:	FALSE


Profile

Description:	If this property is set, default values will be read from highedit.ini.
This profile can also be written with WriteProfile.
Properties which have a corresponding entry in the profile are ignored.

Type:	BOOL

Values:	TRUE	Default values come from the profile.

FALSE	The profile will be ignored.

Default:	FALSE


ReadOnly

Description:	Text is read-only and cannot be changed.

Type:	BOOL

Values:	TRUE	Text is read-only.
FALSE	Text can be modified.

Default:	FALSE


ReturnsVisible

Description:	Show line breaks.

Type:	BOOL

Values:	TRUE 	Show line break.
FALSE 	Hide line break.

Default:	FALSE


RightMargin

Description:	Right margin

Type:	float

Values:	Right margin in the current unit (Unit)


Ruler

Description:	Ruler turned on or off

Type:	BOOL

Values:	TRUE 	Show ruler
FALSE 	Hide ruler

Default:	TRUE


SpacesVisible

Description:	Show spaces.

Type:	BOOL

Values:	TRUE	Spaces are displayed.
FALSE	Spaces are not displayed.

Default:	FALSE


StatusBar

Description:	StatusBar turned on or off

Type:	BOOL

Values:	TRUE	Show StatusBar
FALSE	Hide StatusBar

Default:	TRUE


StyleBar

Description:	Show/hide StyleBar

Type:	BOOL

Values:	TRUE	Show StyleBar
FALSE	Hide StyleBar

Default:	TRUE


Tab

Description:	Turn TabBar on or off.

Type:	BOOL

Values:	TRUE	Show TabBar
FALSE	Hide TabBar

Default:	TRUE


TabsVisible

Description:	Show tabs in the document.

Type:	BOOL

Values:	TRUE	Tabs will be displayed.
FALSE	Tabs will not be displayed.

Default:	FALSE


TextSelectable

Description:	Determines whether selecting will be permitted in read-only mode.

Type:	BOOL

Values:	TRUE	Selecting possible
FALSE	No selecting

Default:	FALSE


TextToWindow

Description:	Adjust for text width automatically.
When the property is set, HighEdit responds to each change in the width of the window by adjusting the text width.

Type:	BOOL

Values:	TRUE	On
FALSE	Off

Default:	FALSE


TopMargin

Description:	Upper margin

Type:	float

Values:	Upper margin in the current unit (Unit)


Undo: Property
Undo

Description:	Turns the UNDO stack for the HighEdit window on or off.
This property can only be set at design time.

Type:	BOOL

Values:	TRUE	Undo is available.
FALSE	Undo is not possible.

Default:	TRUE


Unit

Description:	Unit of measure

This unit of measure applies for all dimensions in the document, e.g. margins, tabs, etc.

Type:	short

Values:	0	Centimeter
1	Inch

Default:	0


VerScrollBar

Description:	Vertical scroll bar

Type:	BOOL

Values:	TRUE	Show
FALSE	Hide

Default:	TRUE


Events

A number of Events are available in HighEdit.

In the list of HighEdit Events which follows, "ctlname" refers to the name of the corresponding HighEdit object.

ctlname_Align

ctlname_ButtonDown

ctlname_ButtonUp

ctlname_Char

ctlname_DisplayFlags

ctlname_ErrorBlockMark

ctlname_ErrorFont

ctlname_ErrorHEFile

ctlname_ErrorLoad

ctlname_ErrorMemory

ctlname_ErrorNotFound

ctlname_ErrorPrinter

ctlname_ErrorRTFFile

ctlname_ErrorSave

ctlname_ErrorSearch

ctlname_ErrorStart

ctlname_ErrorTmpClose

ctlname_ErrorTmpOpen

ctlname_ErrorTmpSpace

ctlname_ErrorWriteAccess

ctlname_FieldEnd

ctlname_FileExists

ctlname_FieldInsert

ctlname_FieldModify

ctlname_FieldSelect

ctlname_FileExists

ctlname_Font

ctlname_FontSize

ctlname_HScroll

ctlname_HyperLinkClicked

ctlname_InitNew

ctlname_KeyDown

ctlname_KeyUp

ctlname_LowMemory

ctlname_MenuBarCommand

ctlname_MouseMove

ctlname_PictureSelect

ctlname_PrintFoot

ctlname_PrintHead

ctlname_QueryCloseChild

ctlname_Spacing

ctlname_Style

ctlname_SysKeyDown

ctlname_SysKeyUp

ctlname_VScroll

ctlname_WrongFileVersion


ctlname_Align (Align)

Description:	The alignment of the line has changed.

Parameters:	Align:

New line alignment as follows:

ALIGN_LEFT	Left-aligned

ALIGN_RIGHT	Right-aligned

ALIGN_CENTER	Center-aligned

ALIGN_JUSTIFY	Justified


ctlname_ButtonDown (XPos, YPos, KeyCode, Shift)

Description:	HighEdit has received the message WM_LBUTTONDOWN, WM_MBUTTONDOWN or WM_RBUTTONDOWN and has redirected the message to the parent window.

Parameters:	XPos:

X-position of the mouse pointer in Twips (printer point/20) relative to the upper left corner of the window.

YPos:

Y-position of the mouse pointer in Twips (printer point/20) relative to the upper left corner of the window.

KeyCode:

Contains the ID of the pressed mouse button (left, middle or right mouse button).

Shift:

Contains the KeyState, i.e., the additional key (Shift, Ctrl) which is being pressed (Shift = 1, Ctrl = 2).


ctlname_ButtonUp (XPos, YPos, KeyCode, Shift
ctlname_ButtonUp (XPos, YPos, KeyCode, Shift)

Description:	HighEdit has received the message WM_LBUTTONUP, WM_MBUTTONUP or WM_RBUTTONUP and has redirected the message to the parent window.

Parameters:	XPos:

X-position of the mouse pointer in Twips (printer point/20) relative to the upper left corner of the window.

YPos:

Y-position of the mouse pointer in Twips (printer point/20) relative to the upper left corner of the window.

KeyCode:

Contains the ID of the pressed mouse button (left, middle or right mouse button).

Shift:

Contains the KeyState, i.e. the additional key (Shift, Alt, Ctrl), which is being pressed.


ctlname_Char (NoChar, KeyCode)

Description:	HighEdit has received the message WM_CHAR and has redirected it to the parent window. If a non-zero value is returned, HighEdit will not process the message any further.

Parameters:	NoChar:

Can be set to the following values:

0:	HighEdit will further process the message.

Non-zero:	Processing by HighEdit is suppressed.

KeyCode:

Contains the ASCII code of the corresponding key.


ctlname_DisplayFlags (Display)

Description:	Special characters set to show or hide

Parameters:	Display:

TRUE	Show special characters

FALSE	Hide special characters


ctlname_ErrorBlockMark (ShowBox)

Description:	An attempt was made to perform a block operation without selecting any block.

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


ctlname_ErrorFont (ShowBox)

Description:	No font could be generated. This can occur if there is too little memory or too few system resources, or if the font table is full.

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


ctlname_ErrorHEFile (ShowBox )

Description:	An attempt was made to open a file which was not saved in HighEdit format.

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


ctlname_ErrorLoad (ShowBox)

Description:	An error occurred while opening a file. Any portions of this file that were already opened will be discarded.

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


ctlname_ErrorMemory (ShowBox)

Description:	Sufficient memory could not be reserved during an action. After this, HighEdit allows only for the text to be displayed and saved. No actions which cause changes to the text are permitted.

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


ctlname_ErrorNotFound (ShowBox)

Description:	The search expression could not be found.

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


ctlname_ErrorPrinter (ShowBox)

Description:	Indicates that no default printer has been set up in Windows. HighEdit will start, but it is recommended that you install a printer, since later changes will affect text formatting. Furthermore, using fonts that are not available on the printer will have an extremely adverse effect on print quality.

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


ctlname_ErrorRTFFile (ShowBox)

Description:	An attempt was made to read a file in Rich-Text format which was not saved in that format.

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


ctlname_ErrorSave (ShowBox)

Description:	An error occurred while text was being saved. The file will be closed, and not deleted.

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


ctlname_ErrorSearch (ShowBox)

Description:	The search expression contains an error (for example, '*' was entered twice).

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


ctlname_ErrorStart (ShowBox)

Description:	HighEdit could not be initialized and started because of a fatal error. This may be the result of insufficient memory or resources.

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


ctlname_ErrorTmpClose (ShowBox)

Description:	The swap file required by HighEdit could not be closed.

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


ctlname_ErrorTmpOpen (ShowBox)

Description:	The swap file required by HighEdit could not be created.

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


ctlname_ErrorTmpSpace (ShowBox)

Description:	No more space is available on the drive for the swap file.

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


ctlname_ErrorWriteAccess (ShowBox)

Description:	A HighEdit file could not be opened while it was being saved, because another application has exclusive access to the file.

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


ctlname_FieldEnd (FieldTyp)

Description:	An input field is being left.

Parameters:	FieldType:

Type of input field


ctlname_FieldInsert (FieldTyp)

Description:	A field was inserted with InsertFunctonPF() or ExtInsertFunctionPF().

Parameters:	FieldType:

Type of input field


ctlname_FieldModify (FieldTyp , Modify )
ctlname_FieldModify (FieldTyp)

Description:	This Event is initiated before leaving an input field. The type can be used to determine whether any subsequent formatting should take place.

Parameters:	FieldType:

Type of the input field accepted

Example:	Field with type TYP_MWSTSATZ is to be tested:

Sub HighEdit_FieldModify (FieldTyp)

If FieldTyp = TYP_MWSTSATZ Then

End If
End Sub


ctlname_FieldSelect (FieldTyp)

Description:	A double-click was performed on an input field, or the Return key was activated.

Parameters:	FieldTyp:

Type of input field


ctlname_FileExists (NoReplace)

Description:	A file is being saved under a name which already exists. NoReplace can be used to determine whether the existing file should be overwritten.

Parameters:	NoReplace:

Can be set to one of the following values:

TRUE	Do not overwrite file. Save process is canceled.

FALSE	File can be overwritten.


ctlname_Font (Font)

Description:	The name of the font has been changed. Information about the font is available from GetFont.

Parameters:	Font:

Index of the new font in the font table


ctlname_FontSize (FontSize)

Description:	The font size has been changed.

Parameters:	FontSize:

Logical height of the new font x 4


ctlname_HScroll (ScrollDistance)

Description:	The window was scrolled horizontally.

Parameters:	ScrollDistance:

Distance that was scrolled in screen points. The direction is indicated by the sign (+/-).


ctlname_HyperLinkClicked(nHypID)

Description:	A hyperlink was clicked on.
You can use GetHyperLinkData to query the hyperlink information with HyperlinkID nHypID.

Parameters:	nHypID:

The unambiguous ID of the hyperlink that was clicked on.


ctlname_InitNew ()

Description:	This Event is initiated after every initialization of HighEdit. Specific settings can be made here, for example field tables, line break, show special characters, etc. Initialization occurs with the following actions:

When HighEdit is started.
When a document is opened (not during insertion).
With the message HE_NEW or the function InitNewDoc.


ctlname_KeyDown (NoChar, KeyCode, Shift)

Description:	HighEdit has received the message WM_KEYDOWN and has redirected the message to the parent window. If a non-zero value is returned, HighEdit will not process the message any further.

Parameters:	NoChar:

Can be set to the following values:

0	HighEdit will further process the message.

Non-zero	Processing by HighEdit is suppressed.

KeyCode:

Contains the ASCII code of the corresponding key.

Shift:

Contains the KeyState, i.e. the additional key (Shift, Alt, Ctrl), which is being pressed.


ctlname_KeyUp (NoChar, KeyCode, Shift)

Description:	HighEdit has received the message WM_KEYUP and has redirected it to the parent window. If a non-zero value is returned, HighEdit will not process the message any further.

Parameters:	NoChar:

Can be set to the following values:

0	HighEdit will further process the message.

Non-zero	Processing by HighEdit is suppressed.

KeyCode:

Contains the ASCII code of the corresponding key.

Shift:

Contains the KeyState, i.e. the additional key (Shift, Alt, Ctrl), which is being pressed.


ctlname_LowMemory (ShowBox)

Description:	It was determined during an action that there is no more memory available. It was still possible to perform the action normally. It is recommended to save the text, exit HighEdit and restart it.

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


ctlname_MenuBarCommand(CommandID, Default)

Description:	This Event occurs if a button on the MenuBar is clicked on.

Parameters:	CommandID:

The ID of the button on the MenuBar (the IDs are defined in the reference interface file "h5api.bas").

Default:

To suppress internal default handling, set the default to FALSE.


ctlname_MouseMove (XPos, YPos, KeyCode, Shift)

Description:	HighEdit has received the message WM_MOUSEMOVE and has redirected it to the parent window.

Parameters:	XPos:

X-position of the mouse pointer in Twips (printer point/20) relative to the upper left corner of the window.

YPos:

Y-position of the mouse pointer in Twips (printer point/20) relative to the upper left corner of the window.

KeyCode:

Contains the ID of the pressed mouse button (left, middle or right mouse button).

Shift:

Contains the KeyState, i.e., the additional key which is being pressed.


ctlname_PictureSelect()

Description:	A double-click was performed on a graphic, or the Return key was activated.

Parameters:	None


ctlname_PrintFoot (hdcPrinter, x1 , y1 , x2 , y2 , NoInternalPrint)

Description:	A page has ended. The footer can be be printed out at the end of the page for this message. If internal headers and footers are being used, printing of headers and footers can be suppressed by setting NoInternalPrint to TRUE.

Parameters:	hdcPrinter:

Printer DC (Device Context)

x1, y1 / x2, y2:

Rectangle available for the text

NoInternalPrint:

Printing of internal footers can be suppressed if the parameter is set to TRUE.


ctlname_PrintHead (hdcPrinter, x1, y1, x2, y2, NoInternalPrint)

Description:	A new page is to be printed. The header can be printed out before it with this message. If internal headers and footers are being used, printing of headers and footers can be suppressed by setting NoInternalPrint to TRUE.

Parameters:	hdcPrinter

Printer DC (Device Context)

x1, y1 / x2, y2:

Rectangle available for the text

NoInternalPrint

Printing of internal headers is suppressed if the parameter is set to TRUE.


ctlname_QueryCloseChild (CloseWindow)

Description:	This event is initiated if HighEdit is about to be terminated and a text change is being made. Close Window can be used to determine whether the window can be closed.

Parameters:	CloseWindow:

Can be set to one of the following values:

TRUE	Window can be closed.

FALSE	Window remains open.


ctlname_Spacing (Spacing)

Description:	The line spacing has been changed.

Parameters:	Spacing:

New line spacing:

SPACING_ONE 	Normal single-line spacing

SPACING_ONEHALF	One-and-a-half-line spacing

SPACING_DOUBLE	Two-line spacing


ctlname_Style (Style)

Description:	The font style has been changed.

Parameters:	Style:

New font style from one or more of the following attributes:

ATTR_STANDARD	Normal

ATTR_BOLD	Bold

ATTR_UNDERLINE	Underline

ATTR_ITALIC 	Italic

ATTR_STRIKEOUT	Strikethrough

ATTR_SUBSCRIPT	Superscript

ATTR_SUPERSCRIPT	Subscript


ctlname_SysKeyDown (NoChar, KeyCode, Shift)

Description:	HighEdit has received the message WM_SYSKEYDOWN and has redirected it to the parent window. If a non-zero value is returned, HighEdit will not process the message any further.

Parameters:	NoChar:

Can be set to the following values:

0	HighEdit will further process the message.

Non-zero	Processing by HighEdit is suppressed.

KeyCode:

Contains the ASCII code of the corresponding key.

Shift:

Contains the KeyState, i.e. the additional key (Shift, Alt, Ctrl), which is being pressed.


ctlname_SysKeyUp (NoChar, KeyCode, Shift)

Description:	HighEdit has received the message WM_SYSKEYUP and has redirected it to the parent window. If a non-zero value is returned, HighEdit will not process the message any further.

Parameters:	NoChar:

Can be set to the following values:

0	HighEdit will further process the message.

Non-zero	Processing by HighEdit is suppressed.

KeyCode:

Contains the ASCII code of the corresponding key.

Shift:

Contains the KeyState, i.e. the additional key (Shift, Alt, Ctrl), which is being pressed.


ctlname_VScroll (ScrollDistance)

Description:	The window has been scrolled vertically.

Parameters:	ScrollDistance:

Distance that was scrolled in screen points. The direction is indicated by the sign (+/-).


ctlname_WrongFileVersion (ShowBox)

Description:	A HighEdit file was opened with an older version of the program than the one it was saved with.

Parameters:	ShowBox:

Can be set to the following values:

TRUE	Default box will be displayed.

FALSE	No default box


HTML Export of Graphics

Description:	Exporting of graphics can be incorporated into a HighEdit Pro document, and is controlled by the flags HTML_IMAGE_xxx. If the flag HTML_IMAGE_NONE is passed, no graphics will be exported. For the flags  HTML_IMAGE_JPG and HTML_IMAGE_GIF, graphics will be exported in JPEG format or Graphics Interchange Format respectively.

A graphic is incorporated into the HTML document as a reference to a source file <img src="filename">. HighEdit Pro follows here the convention of storing the graphics contained in a document under the path and filename of the HTML document to which they belong. A three-digit, continuously incrementing number (.000 .. .999 ) is added as an extension.

The graphics must also be exported as files with the flag HTML_BUFFER. In this case, the HTML document is written into a globally allocated area of memory. For this reason, it is absolutely essential to give a path and filename for buffer export. In this case it is used to generate the graphic files.

Note:	For graphics export in Graphics Interchange Format (HTML_IMAGE_GIF), the appropriate export filter (IM11XGIF.DIL or IM31XGIF.DIL), of the graphics tool, ImageMan, is required. Unfortunately, for copyright reasons we are unable to make it available. If a filter of this type is present in the system, the graphics can also be exported from HighEdit Pro in this format.

See also:	ExportHTML
ExportHTMLDialog
HTML export of hyperlinks and bookmarks
HTML export of data fields


HTML Export of Hyperlinks and Bookmarks

Description:	The export option HTML_HYPERLINKS causes hyperlinks and bookmarks which have been defined in a HighEdit Pro document to be converted into HTML equivalents.

Links and Jump marks are inserted into HTML as "anchors", with the token <a ...>.

A HighEdit Pro hyperlink is thus exported as <a href="szData1">. The string which is stored in the internal hyperlink data structure in HighEdit Pro in the field szData1 is inserted for the placeholder szData1. This might be, for example, a URL which the link uses to branch to some web page on a server.

If the field lData2 of the hyperlink data structure is non-zero, this integer value is interpreted as the ID of a HighEdit Pro bookmark and is appended to the string of the HTML token as a jump instruction as part of the following syntax: <a href="szData1#bkmklData2">. The placeholder szData1 can also be empty, in which case control would branch to the corresponding jump mark in the same HTML document.

A HighEdit Pro bookmark is exported as an HTML jump with the syntax <a name="bkmkID">. The ID here corresponds to the unambiguous bookmark code stored in the HighEdit Pro document which is appended to the constant portion "bkmk" of the name parameter.

Combinations of hyperlinks and bookmarks can also be exported to HTML. HTML tokens are then exported, for example with the following syntax <a name="bkmk1" href="bkmk2">. Here we have a text point called "bkmk1" in the HTML document, from which a jump is executed to the text point "bkmk2" in the same document.

If the option HTML_HYPERLINKS is not set, then the text of a HighEdit Pro hyperlink will be exported as normal text, and bookmarks will not be considered.

See also:	ExportHTML
ExportHTMLDialog
HTML export of graphics
HTML export of data fields


HTML Export of Data Fields

Description:	The option HTML_FORM is used to define the HTML document generated by HighEdit Pro as a form and to connect it with the method "POST". The HTML code for a document of this type has the basic appearance:

<HTML>

<BODY>

<FORM method="POST">

<!-- All additional tokens follow here --!>

</FORM>

</BODY>

</HTML>

In form mode, data fields of the HighEdit Pro document are exported to HTML as input fields, <input type="TEXT" ...>, as long as they are editable. The HighEdit Pro internal field name is used as the name. The content of the HighEdit Pro field is assigned to the input field as a default value. A complete field token might look something like this:

<input type="TEXT" name="{Name}" value="Einstein">.

If the option HTML_FORM is not set, the content of a HighEdit Pro data field is exported as normal text.

See also:	ExportHTML
ExportHTMLDialog
HTML export of graphics
HTML export of hyperlinks and bookmarks